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

詳情請參閱 OAuth 2.0 總覽。

事件

訂閱事件類型

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

OrderBy

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

Projection

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

SortOrder

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

檢視畫面類型

列舉
admin_view 結果同時包含管理員和使用者的公開欄位。
domain_public 結果只包含對網域中其他使用者公開的使用者欄位。