创建和管理用户邀请

本页面介绍了如何使用 Cloud Identity User Invites API 执行一些基本操作。

准备工作

注意:在使用任何 Cloud Identity API 之前,您必须设置 Cloud Identity。如需查看相关说明,请参阅设置 Cloud Identity

在继续此页面的信息之前,请先执行以下任务:

确定邀请资格

概览中所述,如需获得邀请,用户帐号必须满足多个条件。您可以使用 IsInvitableUser() 方法确定给定用户帐号是否符合条件。

REST

如需检查用户帐号的资格,请使用客户 ID 和帐号的电子邮件地址调用 customers.userinvitations.isInvitableUser()

示例请求

GET https://cloudidentity.googleapis.com/v1beta1/customers/C00000000/userinvitations/writer@altostrat.com:isInvitableUser

检索用户邀请

User Invites API 提供了检索单个用户邀请和检索所有用户邀请的方法。在检索所有用户邀请时,您可以选择按状态过滤这些邀请并设置排序顺序。

检索单个用户邀请

REST

如需检索单个用户邀请,请使用客户 ID 和帐号的电子邮件地址调用 customers.userinvitations.get()

示例请求

GET https://cloudidentity.googleapis.com/v1beta1/customers/C00000000/userinvitations/writer@altostrat.com

检索用户邀请列表

在管理员或最终用户处理之前,所有非受管用户自动显示为处于 NOT_YET_SENT 状态的邀请。用户接受邀请后,帐号将不再被视为非受管。

您可以通过在过滤条件中添加 or 运算符来检查多个状态:state=='accepted'||state=='declined'

REST

如需检索用户邀请列表,请使用客户 ID 和任何所需的查询参数调用 customers.userinvitations.list(),以对结果进行过滤、排序和分页。以下示例返回按上次更新时间降序顺序排列的所有非受管用户列表。

示例请求

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

发送用户邀请

用户邀请不会自动发送给符合条件的用户。获取要邀请的用户列表后,您可以使用 customers.userinvitations.send() 方法。如果此列表不存在,该方法还会创建邀请。

REST

如需向用户发送用户邀请电子邮件,请使用客户 ID 和用户帐号的电子邮件地址调用 customers.userinvitations.send()

示例请求

POST https://cloudidentity.googleapis.com/v1beta1/customers/C00000000/userinvitations/writer@altostrat.com:send

取消用户邀请

您可以在接受或拒绝用户邀请之前将其取消。调用 customers.userinvitations.cancel() 方法可以取消邀请。

REST

如需取消用户邀请,请使用客户 ID 和用户帐号的电子邮件地址调用 customers.userinvites.cancel()

示例请求

POST https://cloudidentity.googleapis.com/v1beta1/customers/C00000000/userinvitations/writer@altostrat.com:cancel