建立及管理使用者邀請

本頁面說明如何使用 Cloud Identity User Invitation API 執行一些基本作業。

事前準備

注意：您必須先設定 Cloud Identity，才能使用任何 Cloud Identity API。如需操作說明，請參閱「設定 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() 會傳回所有使用者邀請。

您可以在篩選器中新增 or 運算子，藉此檢查多個狀態： state=='accepted'||state=='declined'

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