Method: users.get

检索用户。

HTTP 请求

GET https://admin.googleapis.com/admin/directory/v1/users/{userKey}

网址采用 gRPC 转码语法。

路径参数

参数
userKey

string

用于在 API 请求中标识用户。该值可以是用户的主电子邮件地址、别名电子邮件地址或唯一用户 ID。

查询参数

参数
customFieldMask

string

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

enum (Projection)

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

enum (ViewType)

是提取用户的仅限管理员视图还是网域级公开视图。如需了解详情，请参阅以非管理员身份检索用户。

请求正文

请求正文必须为空。

响应正文

如果成功，则响应正文包含一个 User 实例。

授权范围

需要以下 OAuth 范围之一：

  • https://www.googleapis.com/auth/admin.directory.user
  • https://www.googleapis.com/auth/admin.directory.user.readonly

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

投影

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

ViewType

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