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 запросе в качестве groupKey используется NNNNN:

POST https://admin.googleapis.com/admin/directory/v1/groups/NNNNN/members

{
   "email": "liz@example.com",
    "role": "MEMBER"
}

role участника группы может быть следующей:

  • OWNER – Эта роль позволяет отправлять сообщения группе, добавлять или удалять участников, изменять роли участников, изменять настройки группы и удалять группу. OWNER должен быть участником группы.
  • MANAGER — Эта роль доступна только в том случае, если Google Workspace активирован с помощью консоли администратора Google. Роль МЕНЕДЖЕРА может выполнять все функции роли ВЛАДЕЛЬЦА, за исключением назначения участника ВЛАДЕЛЬЦЕМ или удаления группы. В группе может быть несколько участников с ролями ВЛАДЕЛЬЦА и МЕНЕДЖЕРА.
  • 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. Информацию о ролях MEMBER, OWNER и MANAGER см. в справочном центре администрирования :

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 .

Когда пользователь удаляется:

  • Участники, которых вы удалите из группы, больше не будут получать электронные письма, адресованные этой группе.
  • Удаление участника из группы не приводит к удалению учетной записи пользователя.
  • Если удалить владельца группы, группа продолжит нормально функционировать. Как администратор, вы можете управлять группой или назначать права владения другому члену группы.