ユーザーの招待状の作成と管理

このページでは、Cloud Identity User Invitation API でいくつかの基本的な操作を行う方法について説明します。

始める前に

注: Cloud Identity API は、Cloud Identity を設定した後に使用する必要があります。手順については、Cloud Identity の設定をご覧ください。

次の作業を実施した後、このページの内容に進んでください。

• User Invitation API の概要を確認します。
• User Invitation API を設定します。

招待資格を判断する

概要で説明されているように、招待されるユーザー アカウントは複数の条件を満たす必要があります。IsInvitableUser() メソッドを使用して、特定のユーザー アカウントが対象かどうかを確認できます。

REST

招待資格のあるユーザー アカウントかどうかを確認するには、お客様 ID とアカウントのメールアドレスを指定して customers.userinvitations.isInvitableUser() を呼び出します。

サンプル リクエスト

GET https://cloudidentity.googleapis.com/v1/customers/C00000000/userinvitations/[e-mail]:isInvitableUser

ユーザーの招待状の取得

User Invitation API は、単一のユーザーの招待状およびすべてのユーザーの招待状を取得するためのメソッドを提供します。すべてのユーザーの招待状を取得するときに、必要に応じて招待状を状態でフィルタし、並べ替え順序を設定できます。

単一のユーザーの招待状を取得する

REST

単一のユーザーの招待状を取得するには、お客様 ID とアカウントのメールアドレスを指定して customers.userinvitations.get() を呼び出します。

サンプル リクエスト

GET https://cloudidentity.googleapis.com/v1/customers/C00000000/userinvitations/[e-mail]

ユーザーの招待状のリストの取得

すべての管理対象外のユーザーは、管理者またはエンドユーザーによって操作を実行されるまで、自動的に NOT_YET_SENT 状態の招待状として表示されます。ユーザーが招待状を受け入れると、アカウントは管理対象外とみなされなくなります。

• リクエストで、上述の状態を指定して customers.userinvitations.list() を呼び出すと、その状態にある招待状のユーザーのみが返されます。
• リクエストで状態を指定せずに customers.userinvitations.list() を呼び出すと、すべてのユーザーの招待状が返されます。

state=='accepted'||state=='declined' のように、フィルタに or 演算子を追加すると、複数の状態を確認できます。

REST

ユーザーの招待状のリストを取得するには、お客様 ID と任意のクエリ パラメータを指定して customers.userinvitations.list() を呼び出します。これにより、結果をフィルタ、並べ替え、ページ分割できます。次の例では、すべての管理対象外のユーザーのリストを、最終更新日時の降順で返します。

サンプル リクエスト

GET https://cloudidentity.googleapis.com/v1/customers/C00000000/userinvitations?filter=state!='accepted'&orderBy='updateTime desc'

ユーザーの招待状を送信する

ユーザーの招待状が、対象となるユーザーに自動的に送信されることはありません。招待するユーザーのリストを取得したら、customers.userinvitations.send() メソッドを使用できます。これにより、招待状が存在しない場合でも作成されます。

REST

ユーザーに招待状メールを送信するには、お客様 ID とユーザー アカウントのメールアドレスを指定して customers.userinvitations.send() を呼び出します。

サンプル リクエスト

POST https://cloudidentity.googleapis.com/v1/customers/C00000000/userinvitations/[e-mail]:send

ユーザーの招待状のキャンセル

ユーザーの招待状は、承認または却下されるまでキャンセルできます。customers.userinvitations.cancel() メソッドを呼び出して招待状をキャンセルします。

REST

ユーザーの招待状をキャンセルするには、お客様 ID とユーザー アカウントのメールアドレスを指定して customers.userinvitations.cancel() を呼び出します。

サンプル リクエスト

POST https://cloudidentity.googleapis.com/v1/customers/C00000000/userinvitations/[e-mail]:cancel