Method: users.list

擷取處於刪除狀態的使用者清單，或網域中所有使用者。

HTTP 要求

GET https://admin.googleapis.com/admin/directory/v1/users

這個網址使用 gRPC 轉碼語法。

查詢參數

參數
customFieldMask

string

以半形逗號分隔的結構定義名稱清單。系統會擷取這些結構定義中的所有欄位。僅限 projection=custom 時設定。
customer

string

客戶 Google Workspace 帳戶的專屬 ID。如果是多重網域帳戶，請使用這個欄位 (而非 domain) 擷取客戶的所有群組，您也可以使用 my_customer 別名來代表帳戶的 customerId。customerId 也會做為 Users 資源的一部分傳回。您必須提供 customer 或 domain 參數。
domain

string

網域名稱。這個欄位可用於取得單一網域的群組。如要傳回客戶帳戶的所有網域，請改用 customer 查詢參數。必須提供 customer 或 domain 參數。
event

enum (Event)

預定採用的事件 (如訂閱)
maxResults

integer

要傳回的結果數上限。
orderBy

enum (OrderBy)

用於排序結果的屬性。
pageToken

string

用於指定清單中下一頁的權杖
projection

enum (Projection)

要為這位使用者擷取哪些欄位。
query

string

搜尋使用者欄位的查詢字串。如要進一步瞭解如何建立使用者查詢，請參閱搜尋使用者。
showDeleted

string

如果設為 true，則會擷取已刪除的使用者清單。(預設值：false)
sortOrder

enum (SortOrder)

要以遞增或遞減順序傳回結果，系統會忽略大小寫。
viewType

enum (ViewType)

擷取管理員僅限管理員或整個網域的公開使用者。詳情請參閱「以非管理員使用者的身分擷取使用者」。

要求主體

要求主體必須為空白。

回應主體

如果成功，回應主體即會包含具有以下結構的資料：

JSON 表示法 
{
  "kind": string,
  "trigger_event": string,
  "etag": string,
  "users": [
    {
      object (User)
    }
  ],
  "nextPageToken": string
}
欄位
kind

string

資源種類。
trigger_event

string

觸發這個回應的事件 (僅適用於推播通知)
etag

string

資源的 ETag。
users[]

object (User)

使用者物件清單。
nextPageToken

string

用於存取這個結果下一頁的權杖。

授權範圍

需要下列其中一種 OAuth 範圍：

  • https://www.googleapis.com/auth/admin.directory.user
  • https://www.googleapis.com/auth/admin.directory.user.readonly
  • https://www.googleapis.com/auth/cloud-platform

詳情請參閱授權指南。

事件

訂閱事件類型

列舉
ADD 使用者建立的事件
DELETE 使用者已刪除事件
MAKE_ADMIN 使用者管理員狀態變更事件
UNDELETE 使用者未刪除的活動
UPDATE 使用者更新的活動

OrderBy

列舉
EMAIL 使用者的主要電子郵件地址。
FAMILY_NAME 使用者的姓氏。
GIVEN_NAME 使用者的姓名。

投影

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

SortOrder

列舉
ASCENDING 遞增順序。
DESCENDING 遞減順序。

檢視畫面類型

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