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

如需了解详情，请参阅 OAuth 2.0 概览。

Projection

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

视图类型

枚举
admin_view	结果包括用户的仅管理员字段和网域公开字段。
domain_public	结果仅包含网域中其他用户可公开查看的用户字段。