Method: members.list
使用集合让一切井井有条
根据您的偏好保存内容并对其进行分类。
检索群组中所有成员的分页列表。此方法会在 60 分钟后超时。如需了解详情,请参阅排查错误代码。
HTTP 请求
GET https://admin.googleapis.com/admin/directory/v1/groups/{groupKey}/members
网址采用 gRPC 转码语法。
路径参数
参数 |
groupKey |
string
用于标识 API 请求中的群组。该值可以是群组的电子邮件地址、群组别名或唯一群组 ID。
|
查询参数
参数 |
includeDerivedMembership |
boolean
是否列出间接成员资格。默认值:false。
|
maxResults |
integer
返回的结果数上限。允许的最大值为 200。
|
pageToken |
string
用于指定列表中下一页的令牌。
|
roles |
string
借助 roles 查询参数,您可以按角色检索群组成员。允许的值包括 OWNER 、MANAGER 和 MEMBER 。
|
响应正文
JSON 表示法 |
{
"kind": string,
"etag": string,
"members": [
{
object (Member )
}
],
"nextPageToken": string
} |
字段 |
kind |
string
资源的类型。
|
etag |
string
资源的 ETag。
|
members[] |
object (Member )
成员对象的列表。
|
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.member
https://www.googleapis.com/auth/admin.directory.group.member.readonly
https://www.googleapis.com/auth/admin.directory.group.readonly
如需了解详情,请参阅授权指南。
如未另行说明,那么本页面中的内容已根据知识共享署名 4.0 许可获得了许可,并且代码示例已根据 Apache 2.0 许可获得了许可。有关详情,请参阅 Google 开发者网站政策。Java 是 Oracle 和/或其关联公司的注册商标。
最后更新时间 (UTC):2025-07-25。
[null,null,["最后更新时间 (UTC):2025-07-25。"],[],[],null,["# Method: members.list\n\nRetrieves a paginated list of all members in a group. This method times out after 60 minutes. For more information, see [Troubleshoot error codes](https://developers.google.com/workspace/admin/directory/v1/guides/troubleshoot-error-codes).\n\n### HTTP request\n\n`GET https://admin.googleapis.com/admin/directory/v1/groups/{groupKey}/members`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|------------|------------------------------------------------------------------------------------------------------------------------------------|\n| `groupKey` | `string` Identifies the group in the API request. The value can be the group's email address, group alias, or the unique group ID. |\n\n### Query parameters\n\n| Parameters ||\n|----------------------------|-----------------------------------------------------------------------------------------------------------------------------------------|\n| `includeDerivedMembership` | `boolean` Whether to list indirect memberships. Default: false. |\n| `maxResults` | `integer` Maximum number of results to return. Max allowed value is 200. |\n| `pageToken` | `string` Token to specify next page in the list. |\n| `roles` | `string` The `roles` query parameter allows you to retrieve group members by role. Allowed values are `OWNER`, `MANAGER`, and `MEMBER`. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|--------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"kind\": string, \"etag\": string, \"members\": [ { object (/workspace/admin/directory/reference/rest/v1/members#Member) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|-----------------|--------------------------------------------------------------------------------------------------------------|\n| `kind` | `string` Kind of resource this is. |\n| `etag` | `string` ETag of the resource. |\n| `members[]` | `object (`[Member](/workspace/admin/directory/reference/rest/v1/members#Member)`)` A list of member objects. |\n| `nextPageToken` | `string` Token used to access next page of this result. |\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://apps-apis.google.com/a/feeds/groups/`\n- `\n https://www.googleapis.com/auth/admin.directory.group`\n- `\n https://www.googleapis.com/auth/admin.directory.group.member`\n- `\n https://www.googleapis.com/auth/admin.directory.group.member.readonly`\n- `\n https://www.googleapis.com/auth/admin.directory.group.readonly`\n\nFor more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent)."]]