Method: groups.list

检索网域或指定用户的所有群组（分页）。

HTTP 请求

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

网址采用 gRPC 转码语法。

查询参数

参数
customer

string

客户的 Google Workspace 账号的唯一 ID。对于多网域账号，如需提取客户的所有群组，请使用此字段，而不是 domain。您还可以使用 my_customer 别名来表示账号的 customerId。customerId 也会作为 Users 资源的一部分返回。您必须提供 customer 或 domain 参数。
domain

string

域名。使用此字段可仅获取一个网域中的群组。如需返回客户账号的所有网域，请改用 customer 查询参数。
maxResults

integer

返回的结果数上限。允许的最大值为 200。
orderBy

enum (OrderBy)

用于对结果进行排序的列
pageToken

string

用于指定列表中的下一页的令牌
query

string

查询字符串搜索。包含一个或多个搜索子句，每个子句都包含字段、运算符和值。如需查看完整文档，请参阅搜索群组。
sortOrder

enum (SortOrder)

是按升序还是降序返回结果。仅在同时使用 orderBy 时有用
userKey

string

用户的电子邮件地址或不可变 ID（如果仅列出指定用户所属的群组）。如果是 ID，则应与用户对象的 ID 一致。不能与 customer 参数搭配使用。

请求正文

请求正文必须为空。

响应正文

如果成功，响应正文将包含结构如下的数据：

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 降序。