检索给定 userKey 的域或用户的所有群组(已分页)。
HTTP 请求
GET https://admin.googleapis.com/admin/directory/v1/groups
网址采用 gRPC 转码语法。
查询参数
参数 | |
---|---|
customer |
客户 Google Workspace 账号的唯一 ID。如果是多网域账号,要提取客户的所有群组,请使用此字段而不是 |
domain |
域名。使用此字段仅获取一个网域中的群组。要返回客户账号的所有域名,请改用 |
maxResults |
返回的结果数上限。允许的最大值为 200。 |
orderBy |
用于对结果进行排序的列 |
pageToken |
用于指定列表中下一页的令牌 |
query |
查询字符串搜索。格式应为“ |
sortOrder |
按升序还是降序返回结果。仅在同时使用 orderBy 时使用 |
userKey |
用户的电子邮件或不可变 ID(如果仅列出这些群组,且指定用户是其中的成员)。如果是 ID,则应与用户对象的 ID 匹配。 |
请求正文
请求正文必须为空。
响应正文
如果成功,响应正文将包含结构如下的数据:
JSON 表示法 |
---|
{
"kind": string,
"etag": string,
"groups": [
{
object ( |
字段 | |
---|---|
kind |
此资源的种类。 |
etag |
资源的 ETag。 |
groups[] |
群组对象的列表。 |
nextPageToken |
用于访问此结果的下一页的令牌。 |
授权范围
需要以下 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 |
降序。 |