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。系統也會在 Users 資源中傳回 customerId。您必須提供 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 使用者更新事件

排序依據

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

預測值

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

SortOrder

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

ViewType

列舉
admin_view 結果包含使用者的管理員專用欄位和網域公開欄位。
domain_public 結果只會包含使用者公開顯示給網域中其他使用者的欄位。