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

詳情請參閱授權指南。

Projection

列舉
BASIC 請勿加入使用者的任何自訂欄位。
CUSTOM 納入 customFieldMask 要求的結構定義中的自訂欄位。
FULL 包括與這位使用者相關聯的所有欄位。

檢視畫面類型

列舉
admin_view 結果包含「僅限管理員」和「網域公開」欄位，分別為使用者。
domain_public 搜尋結果只會包含網域中其他使用者可公開檢視的欄位。