监控用户名单的变化。
HTTP 请求
POST https://admin.googleapis.com/admin/directory/v1/users/watch
网址采用 gRPC 转码语法。
查询参数
参数 | |
---|---|
domain |
域名。填写此字段可仅获取此网域中的用户。要返回多网域填充客户字段中的所有用户, |
customer |
Google Workspace 帐号的不可变 ID。对于多网域,如要提取客户的所有用户,请填写此字段而非网域。 |
event |
要关注的活动。 |
customFieldMask |
以英文逗号分隔的架构名称列表。系统会提取这些架构中的所有字段。仅当投影=自定义时才应设置此字段。 |
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
如需了解详情,请参阅 OAuth 2.0 概览。
事件类型
订阅事件类型
枚举 | |
---|---|
ADD |
用户创建的活动 |
DELETE |
用户删除的活动 |
MAKE_ADMIN |
用户管理员状态更改事件 |
UNDELETE |
用户取消删除了活动 |
UPDATE |
用户更新的活动 |
OrderBy
枚举 | |
---|---|
EMAIL |
用户的主电子邮件地址。 |
FAMILY_NAME |
用户的姓氏。 |
GIVEN_NAME |
用户的姓名。 |
Projection
枚举 | |
---|---|
BASIC |
请勿为用户添加任何自定义字段。 |
CUSTOM |
包含 customFieldMask 中提及的架构中的自定义字段。 |
FULL |
包含与此用户关联的所有字段。 |
SortOrder
枚举 | |
---|---|
ASCENDING |
升序。 |
DESCENDING |
降序。 |
视图类型
枚举 | |
---|---|
admin_view |
结果同时包含管理员专用字段和网域公开字段。 |
domain_public |
结果仅包含网域中其他用户可公开查看的用户字段。 |