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	結果只包含對網域中其他使用者公開的使用者欄位。