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