监听用户列表中的更改。
HTTP 请求
POST https://admin.googleapis.com/admin/directory/v1/users/watch
网址采用 gRPC 转码语法。
查询参数
参数 | |
---|---|
domain |
网域的名称。填写此字段可仅获取此网域中的用户。如需返回多网域中的所有用户,请改为填充客户字段。” |
customer |
Google Workspace 账号的不可变 ID。如果是多网域,如需提取客户的所有用户,请填写此字段,而不是网域。 |
event |
需要注意的事件。 |
customFieldMask |
以英文逗号分隔的架构名称列表。系统会提取这些架构中的所有字段。仅当 projection=custom 时,才应设置此字段。 |
maxResults |
返回的结果数上限。 |
orderBy |
用于对结果进行排序的列 |
pageToken |
用于指定列表中的下一页的令牌 |
projection |
要为此用户提取的字段子集。 |
query |
查询字符串搜索。包含一个或多个搜索子句,每个子句都包含字段、运算符和值。如需查看完整文档,请参阅搜索用户。 |
showDeleted |
如果设置为 true,则检索已删除用户的列表。(默认值:false) |
sortOrder |
是按升序还是降序返回结果。 |
viewType |
是否获取用户的仅限管理员查看的公开视图或网域范围的公开视图。如需了解详情,请参阅以非管理员身份检索用户。 |
请求正文
请求正文包含一个 SubscriptionChannel
实例。
响应正文
如果成功,则响应正文包含一个 SubscriptionChannel
实例。
授权范围
需要以下 OAuth 范围之一:
https://www.googleapis.com/auth/admin.directory.user
https://www.googleapis.com/auth/admin.directory.user.readonly
https://www.googleapis.com/auth/cloud-platform
如需了解详情,请参阅授权指南。
EventType
订阅事件的类型
枚举 | |
---|---|
ADD |
用户创建事件 |
DELETE |
用户删除事件 |
MAKE_ADMIN |
用户管理员状态更改事件 |
UNDELETE |
用户取消删除事件 |
UPDATE |
用户更新事件 |
OrderBy
枚举 | |
---|---|
EMAIL |
用户的主电子邮件地址。 |
FAMILY_NAME |
用户的姓氏。 |
GIVEN_NAME |
用户的名字。 |
投影
枚举 | |
---|---|
BASIC |
不包含用户的任何自定义字段。 |
CUSTOM |
包含 customFieldMask 中提及的架构中的自定义字段。 |
FULL |
包含与相应用户关联的所有字段。 |
SortOrder
枚举 | |
---|---|
ASCENDING |
升序。 |
DESCENDING |
降序。 |
ViewType
枚举 | |
---|---|
admin_view |
结果包括仅限管理员访问的字段和面向网域公开的字段。 |
domain_public |
结果仅包含对网域中的其他用户公开可见的用户字段。 |