建立及管理使用者邀請

本頁說明如何使用 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() ，但要求中沒有狀態，系統會傳回所有使用者邀請。

您可以在篩選器中加入 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

如要傳送使用者邀請電子郵件給使用者，請呼叫 customers.userinvitations.send() 並提供客戶 ID 和使用者帳戶的電子郵件地址。

要求範例

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