Method: members.list
Оптимизируйте свои подборки
Сохраняйте и классифицируйте контент в соответствии со своими настройками.
Получает постраничный список всех членов группы. Время действия этого метода истекает через 60 минут. Дополнительную информацию см. в разделе Устранение кодов ошибок .
HTTP-запрос
GET https://admin.googleapis.com/admin/directory/v1/groups/{groupKey}/members
URL-адрес использует синтаксис транскодирования gRPC .
Параметры пути
Параметры |
---|
groupKey | string Идентифицирует группу в запросе API. Значением может быть адрес электронной почты группы, псевдоним группы или уникальный идентификатор группы. |
Параметры запроса
Параметры |
---|
includeDerivedMembership | boolean Указывать ли косвенное членство. По умолчанию: ложь. |
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
Дополнительную информацию см. в руководстве по авторизации .
Если не указано иное, контент на этой странице предоставляется по лицензии Creative Commons "С указанием авторства 4.0", а примеры кода – по лицензии Apache 2.0. Подробнее об этом написано в правилах сайта. Java – это зарегистрированный товарный знак корпорации Oracle и ее аффилированных лиц.
Последнее обновление: 2025-07-25 UTC.
[null,null,["Последнее обновление: 2025-07-25 UTC."],[],[],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)."]]