API каталога: члены группы
Оптимизируйте свои подборки
Сохраняйте и классифицируйте контент в соответствии со своими настройками.
Добавить участника в группу
Чтобы добавить участника в группу, используйте следующий запрос POST и включите авторизацию, описанную в разделе «Авторизация запросов» . Членом группы может быть пользователь или другая группа. groupKey — это адрес электронной почты группы нового участника или уникальный id группы. Свойства запроса и ответа см. в справочнике по API :
POST https://admin.googleapis.com/admin/directory/v1/groups/groupKey/members
Если вы добавите группу в качестве участника другой группы, может пройти задержка до 10 минут, прежде чем участники дочерней группы станут членами родительской группы. Кроме того, API возвращает ошибку для циклов членства в группах. Например, если группа1 является членом группы2, группа2 не может быть членом группы1.
JSON-запрос
Следующий запрос JSON показывает пример тела запроса, который создает члена группы. Адрес электронной почты участника — liz@example.com, а роль участника в группе — « MEMBER . Запрос POST использует NNNNN для groupKey :
POST https://admin.googleapis.com/admin/directory/v1/groups/NNNNN/members
{
"email": "liz@example.com",
"role": "MEMBER"
} role члена группы может быть:
-
OWNER – эта роль может изменять отправку сообщений в группу, добавлять или удалять участников, изменять роли участников, изменять настройки группы и удалять группу. OWNER должен быть членом группы. -
MANAGER . Эта роль доступна только в том случае, если Google Workspace включен с помощью консоли администратора. Роль МЕНЕДЖЕР может делать все, что делает роль ВЛАДЕЛЕЦ, за исключением назначения участника ВЛАДЕЛЬЦЕМ или удаления группы. В группе может быть несколько членов ВЛАДЕЛЬЦА и МЕНЕДЖЕРА. -
MEMBER – эта роль может подписываться на группу, просматривать архивы обсуждений и просматривать список участников группы. Дополнительную информацию о ролях участников см. в справочном центре администрирования .
JSON-ответ
Успешный ответ возвращает код состояния HTTP 200 и информацию о членстве участника. id — это уникальный идентификатор членства участника:
{
"kind": "directory#member",
"id": "group member's unique ID",
"email": "liz@example.com",
"role": "MEMBER",
"type": "GROUP"
} type члена группы может быть:
-
GROUP – Участник другой группы. -
MEMBER – Участник является пользователем.
Обновить членство в группе
Чтобы обновить членство в группе, используйте следующий запрос PUT и включите авторизацию, описанную в разделе «Запросы авторизации» . groupKey — это адрес электронной почты группы или уникальный id группы, memberKey — это основной адрес электронной почты пользователя или группы, псевдоним адреса электронной почты пользователя или уникальный id пользователя. Свойства запроса и ответа см. в справочнике по API :
PUT https://admin.googleapis.com/admin/directory/v1/groups/groupKey/members/memberKey
JSON-запрос
Следующий запрос JSON показывает пример тела запроса, который обновляет настройки членства в группе. Адрес электронной почты участника — liz@example.com, а роль участника в группе изменена с MEMBER на MANAGER . groupKey запроса PUT в этом примере — NNNNN. Информацию о ролях ЧЛЕН, ВЛАДЕЛЕЦ и МЕНЕДЖЕР см. в справочном центре администрирования :
PUT https://admin.googleapis.com/admin/directory/v1/groups/NNNNN/members/liz@example.com
{
"email": "liz@example.com",
"role": "MANAGER"
} JSON-ответ
Успешный ответ возвращает код состояния HTTP 200 и обновленную информацию о членстве. id — это уникальный идентификатор членства участника:
{
"kind": "directory#member",
"id": "group member's unique ID",
"email": "liz@example.com",
"role": "MANAGER",
"type": "GROUP"
} Получить члена группы
Чтобы получить членство в группе, используйте следующий запрос GET и включите авторизацию, описанную в разделе Авторизация запросов . groupKey — это адрес электронной почты группы или уникальный id группы, memberKey — это основной адрес электронной почты пользователя или группы, псевдоним адреса электронной почты пользователя или уникальный id пользователя. Свойства запроса и ответа см. в справочнике по API :
GET https://admin.googleapis.com/admin/directory/v1/groups/groupKey/members/memberKey
JSON-ответ
Успешный ответ возвращает код состояния HTTP 200 и информацию о членстве участника. id — это уникальный идентификатор членства участника:
{
"kind": "directory#member",
"id": "group member's unique ID",
"email": "liz@example.com",
"role": "MANAGER",
"type": "GROUP"
} Получить всех членов группы
Чтобы получить всех членов группы, используйте следующий запрос GET и включите авторизацию, описанную в разделе «Авторизация запросов» . groupKey — это адрес электронной почты группы или уникальный id группы. Необязательная строка запроса roles представляет собой фильтр, позволяющий получать членов группы по роли, а полученные коллекции ролей располагаются в порядке, указанном в фильтре roles . Свойства запроса и ответа см. в справочнике по API . Для удобства чтения в этом примере используются возвраты строк:
GET https://admin.googleapis.com/admin/directory/v1/groups/groupKey/members
?pageToken=pagination token
&roles=one or more of OWNER,MANAGER,MEMBER separated by a comma
&maxResults=maximum results per response page
Все участники возвращаются в алфавитном порядке адресов электронной почты участников. И используйте строку запроса pageToken для ответов с большим количеством участников. В случае нумерации страниц ответ возвращает свойство nextPageToken , которое содержит токен для следующей страницы результатов ответа. Ваш следующий запрос использует этот токен в качестве значения строки запроса pageToken .
JSON-ответ
Успешный ответ возвращает код состояния HTTP 200 и список информации об участниках. id — это уникальный идентификатор членства участника. В этом ответе есть nextPageToken для следующего списка членов группы:
{
"kind": "directory#members",
"members": [
{
"kind": "directory#member",
"id": "group member's unique ID",
"email": "liz@example.com",
"role": "MANAGER",
"type": "USER"
},
{
"kind": "directory#member",
"id": "group member's unique ID",
"email": "radhe@example.com",
"role": "MANAGER",
"type": "USER"
}
],
"nextPageToken": "NNNNN"
} Удаление членства в группе
Чтобы удалить членство участника в группе, используйте следующий запрос DELETE и включите авторизацию, описанную в разделе «Авторизация запросов» . groupKey — это уникальный id группы, memberKey — это основной адрес электронной почты удаленного пользователя или участника группы или уникальный id пользователя. Свойства запроса и ответа см. в Справочнике API .:
DELETE https://admin.googleapis.com/admin/directory/v1/groups/groupKey/members/memberKey
Например, этот запрос DELETE удаляет участника, чей groupKey имеет значение nnn и memberKey является основным адресом электронной почты пользователя, liz@example.com:DELETE https://admin.googleapis.com/admin/directory/v1/groups/nnnn/members/liz@example.com
Успешный ответ возвращает код состояния HTTP 200 .
Когда участник удаляется:
- Удаленные вами участники больше не будут получать электронную почту, адресованную группе.
- Удаление участника из группы не удаляет учетную запись пользователя.
- Если вы удалите владельца группы, группа по-прежнему будет работать нормально. Как администратор, вы можете управлять группой или передать право собственности другому участнику группы.
Если не указано иное, контент на этой странице предоставляется по лицензии Creative Commons "С указанием авторства 4.0", а примеры кода – по лицензии Apache 2.0. Подробнее об этом написано в правилах сайта. Java – это зарегистрированный товарный знак корпорации Oracle и ее аффилированных лиц.
Последнее обновление: 2025-08-29 UTC.
[null,null,["Последнее обновление: 2025-08-29 UTC."],[],[],null,["# Directory API: Group Members\n\n|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| 1. [Add a member to a group](#create_member) 2. [Update a group membership](#update_member) 3. [Retrieve a group's member](#get_member) 4. [Retrieve all group members](#get_all_members) 5. [Delete membership in a group](#delete_member) |\n\nAdd a member to a group\n-----------------------\n\nTo add a member to a group, use the following `POST` request and include the authorization described in [Authorize requests](/workspace/admin/directory/v1/guides/authorizing). A group member can be a user or another group. The `groupKey` is the new member's group email address or the group's unique `id`. For the request and response properties, see the [API Reference](/workspace/admin/directory/v1/reference/members/insert): \n\n```\nPOST https://admin.googleapis.com/admin/directory/v1/groups/groupKey/members\n```\n\nIf you add a group as a member of another group, there may be a delay of up to 10 minutes before the child group's members appear as members of the parent group. In addtion, the API returns an error for cycles in group memberships. For example, if group1 is a member of group2, group2 cannot be a member of group1.\n\n### JSON request\n\nThe following JSON request shows a sample request body that creates a group member. The member's email address is liz@example.com and the member's role in the group is as a `MEMBER`. The `POST` request uses NNNNN for the `groupKey`: \n\n```\nPOST https://admin.googleapis.com/admin/directory/v1/groups/NNNNN/members\n``` \n\n```transact-sql\n{\n \"email\": \"liz@example.com\",\n \"role\": \"MEMBER\"\n}\n```\n\nA group member's `role` can be:\n\n- `OWNER` -- This role can change send messages to the group, add or remove members, change member roles, change group's settings, and delete the group. An `OWNER` must be a member of the group.\n- `MANAGER` -- This role is only available if the Google Workspace is enabled using the Admin console. A MANAGER role can do everything done by an OWNER role except make a member an OWNER or delete the group. A group can have multiple OWNER and MANAGER members.\n- `MEMBER` -- This role can subscribe to a group, view discussion archives, and view the group's membership list. For more information about member roles, see the [administration help center](http://support.google.com/a/bin/answer.py?answer=167094).\n\n\u003cbr /\u003e\n\n### JSON response\n\nA successful response returns an [HTTP 200 status code](http://wikipedia.org/wiki/List_of_HTTP_status_codes) and the member's membership information. The `id` is the member's unique membership ID: \n\n```carbon\n{\n \"kind\": \"directory#member\",\n \"id\": \"group member's unique ID\",\n \"email\": \"liz@example.com\",\n \"role\": \"MEMBER\",\n \"type\": \"GROUP\"\n }\n```\n\nA group member's `type` can be:\n\n- `GROUP` -- The member is another group.\n- `MEMBER` -- The member is a user\n\n\u003cbr /\u003e\n\nUpdate a group membership\n-------------------------\n\nTo update a group membership, use the following `PUT` request and include the authorization described in [Authorize requests](/workspace/admin/directory/v1/guides/authorizing). The `groupKey` is the group's email address or the group's unique `id`, and the `memberKey` is the user's or group's primary email address, a user's alias email address, or the user's unique `id`. For the request and response properties, see the [API Reference](/workspace/admin/directory/v1/reference/members/update): \n\n```\nPUT https://admin.googleapis.com/admin/directory/v1/groups/groupKey/members/memberKey\n```\n| **Note:** The API also supports the [patch semantics](/workspace/admin/directory/v1/guides/performance#patch).\n\n### JSON request\n\nThe following JSON request shows a sample request body that updates a group membership settings. The member's email address is liz@example.com and the member's role in the group is changed from a `MEMBER` to a `MANAGER`. The `PUT` request's `groupKey` in this example is NNNNN. For information about the MEMBER, OWNER and MANAGER roles, see the [administration help center](http://support.google.com/a/bin/answer.py?answer=167094): \n\n```\nPUT https://admin.googleapis.com/admin/directory/v1/groups/NNNNN/members/liz@example.com\n``` \n\n```transact-sql\n{\n \"email\": \"liz@example.com\",\n \"role\": \"MANAGER\"\n}\n```\n\n### JSON response\n\nA successful response returns an [HTTP 200 status code](http://wikipedia.org/wiki/List_of_HTTP_status_codes) and the updated membership information. The `id` is the member's unique membership ID: \n\n```carbon\n{\n \"kind\": \"directory#member\",\n \"id\": \"group member's unique ID\",\n \"email\": \"liz@example.com\",\n \"role\": \"MANAGER\",\n \"type\": \"GROUP\"\n }\n```\n\nRetrieve a group's member\n-------------------------\n\nTo retrieve a group membership, use the following `GET` request and include the authorization described in [Authorize requests](/workspace/admin/directory/v1/guides/authorizing). The `groupKey` is the group's email address or the group's unique `id`, and the `memberKey` is the user's or group's primary email address, a user's alias email address, or the user's unique `id`. For the request and response properties, see the [API Reference](/workspace/admin/directory/v1/reference/members/get): \n\n```\nGET https://admin.googleapis.com/admin/directory/v1/groups/groupKey/members/memberKey\n```\n\n### JSON response\n\nA successful response returns an [HTTP 200 status code](http://wikipedia.org/wiki/List_of_HTTP_status_codes) and the member's membership information. The `id` is the member's unique membership ID: \n\n```carbon\n{\n \"kind\": \"directory#member\",\n \"id\": \"group member's unique ID\",\n \"email\": \"liz@example.com\",\n \"role\": \"MANAGER\",\n \"type\": \"GROUP\"\n }\n```\n\nRetrieve all group members\n--------------------------\n\nTo retrieve all group members, use the following `GET` request and include the authorization described in [Authorize requests](/workspace/admin/directory/v1/guides/authorizing). The `groupKey` is the group's email address or the group's unique `id`. The optional `roles` query string is a filter allowing you to retrieve group members by role and the resulting role collections are in the order given in the `roles` filter. For the request and response properties, see the [API Reference](/workspace/admin/directory/v1/reference/members/list). For readability, this example uses line returns: \n\n```\nGET https://admin.googleapis.com/admin/directory/v1/groups/groupKey/members\n?pageToken=pagination token\n&roles=one or more of OWNER,MANAGER,MEMBER separated by a comma\n&maxResults=maximum results per response page\n```\n\nAll members are returned in the alphabetical order of the members' email addresses. And use the `pageToken` query string for responses with large number of members. In the case of pagination, the response returns the `nextPageToken` property which has a token for the next page of response results. Your next request uses this token as the `pageToken` query string value.\n\n### JSON response\n\nA successful response returns an [HTTP 200 status code](http://wikipedia.org/wiki/List_of_HTTP_status_codes) and the list of member information. The `id` is the member's unique membership ID. There is a `nextPageToken` for the follow-on list of group members in this response: \n\n```carbon\n{\n \"kind\": \"directory#members\",\n \"members\": [\n {\n \"kind\": \"directory#member\",\n \"id\": \"group member's unique ID\",\n \"email\": \"liz@example.com\",\n \"role\": \"MANAGER\",\n \"type\": \"USER\"\n },\n {\n \"kind\": \"directory#member\",\n \"id\": \"group member's unique ID\",\n \"email\": \"radhe@example.com\",\n \"role\": \"MANAGER\",\n \"type\": \"USER\"\n }\n ],\n \"nextPageToken\": \"NNNNN\"\n}\n```\n\nDelete membership in a group\n----------------------------\n\nTo delete a member's membership in a group, use the following `DELETE` request and include the authorization described in [Authorize requests](/workspace/admin/directory/v1/guides/authorizing). The `groupKey` is the group's unique `id`, and `memberKey` is the deleted user or group member's primary email address or the user's unique `id`. For the request and response properties, see the [API Reference](/workspace/admin/directory/v1/reference/members/delete).: \n\n```\nDELETE https://admin.googleapis.com/admin/directory/v1/groups/groupKey/members/memberKey\n```\nFor example, this `DELETE` request deletes the member whose `groupKey` is nnn and whose `memberKey` is the user's primary email address, liz@example.com: \n\n```\nDELETE https://admin.googleapis.com/admin/directory/v1/groups/nnnn/members/liz@example.com\n```\n\nA successful response returns an [HTTP 200 status code](http://wikipedia.org/wiki/List_of_HTTP_status_codes).\n\nWhen a member is deleted:\n\n- Members you remove no longer receive email addressed to the group.\n- Removing a member from a group does not delete the user's account.\n- If you delete the group owner, the group still works normally. As an administrator, you can manage the group or assign ownership to another group member\n\n\u003cbr /\u003e"]]
