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

架构名称列表（以英文逗号分隔）。系统将提取这些架构中的所有字段。仅当映射=custom 时，才应设置此字段。
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

有关详情，请参阅授权指南。

EventType

订阅事件类型

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

OrderBy

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

Projection

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

SortOrder

枚举
ASCENDING 升序。
DESCENDING 降序。

ViewType

枚举
admin_view 结果包含仅限管理员的字段和网域公共的字段。
domain_public 结果仅包含网域中的其他用户公开显示的用户字段。