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 包括与此用户关联的所有字段。

视图类型

枚举
admin_view 结果包括用户的“管理员专用”字段和“网域公开”字段。
domain_public 结果仅包含网域中对其他用户可见的该用户的字段。