Method: groups.list

检索具有 userKey 的网域或用户的所有群组(分页)。

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 匹配。

请求正文

请求正文必须为空。

响应正文

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

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