Method: users.list

检索已删除用户或网域中所有用户的分页列表。

HTTP 请求

GET https://admin.googleapis.com/admin/directory/v1/users

网址采用 gRPC 转码语法。

查询参数

参数
customFieldMask

string

以英文逗号分隔的架构名称列表。系统会提取这些架构中的所有字段。仅当 projection=custom 时才应设置此字段。
customer

string

客户 Google Workspace 账号的唯一 ID。如果是多网域账号，如要获取客户的所有用户，请使用此字段而不是 domain。您还可以使用 my_customer 别名来表示您账号的customerId。customerId 也会作为 Users 资源的一部分返回。您必须提供 customer 或 domain 参数。
domain

string

域名。使用此字段可仅获取来自一个网域的用户。要返回客户账号的所有域名，请改用 customer 查询参数。必须提供 customer 或 domain 参数。
event

enum (Event)

针对订阅所针对的事件（如果是订阅）
maxResults

integer

返回的结果数上限。
orderBy

enum (OrderBy)

用于对结果进行排序的属性。
pageToken

string

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

enum (Projection)

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

string

用于搜索用户字段的查询字符串。如需详细了解如何构建用户查询，请参阅搜索用户。
showDeleted

string

如果设置为 true，则检索已删除用户列表。（默认值：false）
sortOrder

enum (SortOrder)

是按升序还是降序返回结果，不区分大小写。
viewType

enum (ViewType)

是获取用户的公开视图，还是仅管理员可见。如需了解详情，请参阅以非管理员身份检索用户。

请求正文

请求正文必须为空。

响应正文

如果成功，响应正文将包含结构如下的数据：

JSON 表示法 
{
  "kind": string,
  "trigger_event": string,
  "etag": string,
  "users": [
    {
      object (User)
    }
  ],
  "nextPageToken": string
}
字段
kind

string

此资源的种类。
trigger_event

string

触发此响应的事件（仅用于推送响应）
etag

string

资源的 ETag。
users[]

object (User)

user 对象的列表。
nextPageToken

string

用于访问此结果的下一页的令牌。

授权范围

需要以下 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 降序。

ViewType

枚举
admin_view 结果同时包含用户的仅管理员专用字段和网域公开字段。
domain_public 结果仅包含用户字段，且相应网域中其他用户可公开查看。