检索包含已删除用户或网域中所有用户的分页列表。
HTTP 请求
GET https://admin.googleapis.com/admin/directory/v1/users
网址采用 gRPC 转码语法。
查询参数
参数 | |
---|---|
customFieldMask |
架构名称的逗号分隔列表。系统将提取这些架构中的所有字段。仅当 |
customer |
客户的 Google Workspace 帐号的唯一 ID。对于多网域帐号,如要提取客户的所有群组,请使用此字段而非 |
domain |
域名。使用此字段只能从一个网域获取群组。要返回客户帐号的所有网域,请改用 |
event |
订阅事件(如有订阅) |
maxResults |
返回的结果数上限。 |
orderBy |
用于对结果进行排序的属性。 |
pageToken |
用于指定列表中的下一页的令牌 |
projection |
要为此用户提取的字段子集。 |
query |
用于搜索用户字段的查询字符串。如需详细了解如何构建用户查询,请参阅搜索用户。 |
showDeleted |
如果设置为 |
sortOrder |
以升序或降序返回结果,不区分大小写。 |
viewType |
获取用户的管理员权限(仅限管理员还是整个网域)。有关详情,请参阅以非管理员用户身份检索用户。 |
请求正文
请求正文必须为空。
响应正文
如果成功,响应正文将包含结构如下的数据:
JSON 表示法 |
---|
{
"kind": string,
"trigger_event": string,
"etag": string,
"users": [
{
object ( |
字段 | |
---|---|
kind |
此资源的种类。 |
trigger_event |
触发此响应的事件(仅在推送响应中使用) |
etag |
资源的 ETag。 |
users[] |
用户对象列表。 |
nextPageToken |
用于访问此结果的下一页的令牌。 |
授权范围
需要以下 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 |
结果仅包含网域中对其他用户可见的该用户的字段。 |