ドメインオーナー移譲APIと操作手順
- erika_nakagawa
- 二宮力也
ここでは、API経由でドメインオーナーの移譲の操作をする方法とCloudGear Accounts画面上での操作方法をご説明します。ドメインの移譲を行うとドメインに紐づく契約もすべて移譲されます。
API経由での移譲方法
1. アクセストークンの取得
ドメインオーナー移譲APIにリクエストを送信するには、事前にOAuth 2.0 認証フローを使用してアクセストークンを取得する必要があります。
ユーザー認証の連携で作成した認証情報を使用し、WebAPIに使用するアクセストークンを取得します。
Authorization Codeによるアクセストークンの取得方法については、こちらのページをご覧ください。
契約者の移譲を行うためのアクセストークンには、「api.domain.transfer.owners:read」、「api.domain.transfer.owners:write」スコープが必要となります。
2.ドメインオーナー移譲メールの送信
ドメインオーナー移譲APIを使用して指定したuidのアカウント宛に「ドメインオーナーの移譲」のメールを送信します。現在のドメインオーナーのみリクエストできます。移譲処理の実行までの期限は1週間です。
リクエスト
PUT /v1/domains/{domainId}/transfer_ownerプレースホルダー | 説明 |
|---|---|
<domainId> | ドメインオーナーを移譲したいドメインのIDを指定します。 |
リクエストボディ | 説明 |
|---|---|
<uid> | 移譲したいアカウントのuidを指定します。すでにドメインに所属しているアカウントには移譲できません。 |
3.ドメインオーナー移譲処理の実行
ドメインオーナー移譲の処理を実行します。移譲を依頼されたユーザー（2の操作でメールを受け取ったユーザー）のみリクエストできます。
リクエスト
POST /v1/domains/{domainId}/transfer_owner
プレースホルダー | 説明 |
|---|---|
<domainId> | 契約者を移譲したいサブスクリプションのIDを指定します。 |
ドメインオーナー移譲状況の取得
2の操作で登録された内容を確認します。現在のドメインオーナーもしくは移譲を依頼されたユーザーのみリクエストできます。
リクエスト
GET /v1/domains/{domainId}/transfer_owner
ドメインオーナー移譲のリクエストの取り消し
2の操作で登録した情報の削除をします。現在のドメインオーナーのみリクエストできます。
リクエスト
CloudGear Accounts画面上での操作
1.ドメインオーナー移譲メールの送信
ドメインオーナーのアカウントでCloudGear Accountsにアクセスします。
「ドメイン」メニューをクリックし、ドメインのダッシュボード画面を表示し、サイドバーの「ドメイン設定」を選択します。
下にスクロールすると「オーナーの移譲」カードが表示されています。
「招待を送る」をクリックします。
モーダルが開きます。
インプットに移譲したいアカウントのユーザーIDを入力し、OKをクリックします。
画面下部に「ドメインオーナー変更メールを送信しました。」とメッセージが表示され、オーナーの移譲カード内に「【ユーザーID】のユーザー宛にメールを送信済みです。」と表示されます。
2.ドメインオーナー移譲処理の実行
1の手順が終わると指定したユーザーIDのアカウント宛にメールが届きます。
「ドメインオーナーの移譲を行う」をクリックします。
移譲先のユーザーでログイン後、「ドメインオーナーの移譲」ページが表示されます。
「変更する」ボタンをクリックします。
移譲が完了し、ダッシュボード画面が表示されます。
ドメインオーナー移譲のリクエストの取り消し
1の手順後、「招待を取り消す」をクリックします。
招待が取り消され、招待前の状態に戻ります。