Method: users.watch

监控用户列表中的更改。

HTTP 请求

POST https://admin.googleapis.com/admin/directory/v1/users/watch

网址采用 gRPC 转码语法。

查询参数

参数
domain

string

网域的名称。填写此字段,让系统仅从此网域获取用户。而是改为在多网域填充客户字段中返回所有用户。”

customer

string

Google Workspace 帐号的不可变 ID。如果是多网域客户,如要提取客户的所有用户,请填写此字段而非网域。

event

enum (EventType)

值得关注的事件。

customFieldMask

string

架构名称的逗号分隔列表。系统将提取这些架构中的所有字段。仅当投影=自定义时,才应设置此字段。

maxResults

integer

返回的结果数上限。

orderBy

enum (OrderBy)

用于对结果进行排序的列

pageToken

string

用于指定列表中的下一页的令牌

projection

enum (Projection)

要为此用户提取的字段子集。

query

string

查询字符串搜索。格式应为“”。完整文档位于 https: //developers.google.com/admin-sdk/directory/v1/guides/search-users

showDeleted

string

如果设置为 true,则检索已删除用户的列表。(默认值:false)

sortOrder

enum (SortOrder)

返回升序还是降序结果。

viewType

enum (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

如需了解详情,请参阅授权指南

事件类型

订阅事件的类型

枚举
ADD 用户创建的事件
DELETE 用户删除了活动
MAKE_ADMIN 用户管理员状态更改事件
UNDELETE 用户取消删除事件
UPDATE 用户更新了活动

OrderBy

枚举
EMAIL 用户的主电子邮件。
FAMILY_NAME 用户的姓氏。
GIVEN_NAME 用户的名字。

投影

枚举
BASIC 请勿包含用户的任何自定义字段。
CUSTOM 加入 customFieldMask 中提到的架构中的自定义字段。
FULL 包括与此用户关联的所有字段。

SortOrder

枚举
ASCENDING 升序。
DESCENDING 降序。

视图类型

枚举
admin_view 结果中既包括管理员字段,也包括网域公共字段。
domain_public 结果仅包含网域中对其他用户可见的该用户的字段。