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 遞減排序。

ViewType

列舉
admin_view 結果包含該使用者的管理員專用欄位和公開網域欄位。
domain_public 結果只會包含對網域內其他使用者公開檢視的欄位。