Method: groups.list

擷取使用者金鑰 (分頁) 的所有網域或使用者群組。

HTTP 要求

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

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

查詢參數

參數
customer

string

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

domain

string

網域名稱。這個欄位可用於取得單一網域的群組。如要傳回客戶帳戶的所有網域,請改用 customer 查詢參數。

maxResults

integer

要傳回的結果數上限。允許的值上限為 200。

orderBy

enum (OrderBy)

用於排序結果的資料欄

pageToken

string

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

query

string

查詢字串搜尋。格式應為「」。完整說明文件請參閱 https: //developers.google.com/admin-sdk/directory/v1/guides/search-groups

sortOrder

enum (SortOrder)

要以遞增或遞減順序傳回結果。只有在同時使用 orderBy 時才能使用

userKey

string

使用者的電子郵件 ID 或可變更 ID 時,如果只有納入這些群組,就等於是該使用者。如果是 ID,則應與 User 物件的 ID 相符。

要求主體

要求主體必須為空白。

回應主體

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

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

string

此為資源種類。

etag

string

資源的 ETag。

groups[]

object (Group)

群組物件清單。

nextPageToken

string

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

授權範圍

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

  • https://apps-apis.google.com/a/feeds/groups/
  • https://www.googleapis.com/auth/admin.directory.group
  • https://www.googleapis.com/auth/admin.directory.group.readonly

詳情請參閱授權指南

OrderBy

列舉
EMAIL 群組的電子郵件。

SortOrder

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