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 .

Когда участник удаляется:

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