Получить список групп организации

Возвращает список групп с возможностью поиска группы по ее рассылке.

Примечание

Чтобы выполнить запрос, приложению требуется одно из разрешений:

directory:read_groups — просмотр данных групп;
directory:write_groups — просмотр и изменение данных групп.

Запрос

GET https://cloud-api.yandex.net/v1/directory/organizations/{org_id}/groups

Path-параметры

Имя параметра	Тип	Описание
org_id *	integer	Идентификатор организации.

Query-параметры

Имя параметра	Тип	Описание
email	string	Адрес рассылки, по которому будут отфильтрованы группы.
limit	integer	Максимальное количество записей в ответе.
offset	integer	Смещение, с которого начинается выборка данных. Поддерживаются только значения `offset`, кратные значению `limit`.

Заголовки

Authorization: OAuth <токен>

Пример

Пример запроса

curl -X GET -H "Authorization: OAuth <токен>" https://cloud-api.yandex.net/v1/directory/organizations/123456/groups

Ответ

Успешный ответ

Результатом корректного запроса является ответ с кодом 200 и телом в формате JSON, где содержится объект со списком групп.

200 OK — запрос выполнен успешно.

Имя параметра	Тип	Описание
limit	integer	Максимальное количество записей в ответе.
offset	integer	Смещение, с которого начинается выборка данных.
total	integer	Общее количество записей, подходящих по параметрам запроса.
items	array	Список групп, отфильтрованных по адресу рассылки.

v1Group

Поле	Тип	Описание
aliases	string[]	Алиасы почтовых ящиков группы.
created_at	string<date-time>	Дата и время создания группы.
description	string	Описание группы.
email	string	Адрес почтовой рассылки группы.
id	integer<int64>	Идентификатор группы.
label	string	Имя почтовой рассылки группы. Например, для адреса `new-group@ваш-домен.ru` имя почтовой рассылки — это `new-group`.
member_of	integer<int64>[]	Идентификаторы групп, в которые входит эта группа.
members_count	integer<int64>	Количество участников группы.
name	string	Название группы.
removed	boolean	Признак удаленной группы: `true` — группа удалена; `false` — группа действующая.
type	string	Тип группы. Возможные значения: `generic` — стандартная группа, созданная одним из сотрудников организации. Пользователи могут изменять параметры такой группы и ее состав. `organization_admin` — группа администраторов организации. Неизменяемая техническая группа. `robots` — группа роботов. Неизменяемая техническая группа. `organization_deputy_admin` — группа менеджеров организации. Неизменяемая техническая группа.

Пример

Пример ответа

{
  "limit": 0,
  "offset": 0,
  "total": 0,
  "items": [
    {
      "id": 0,
      "name": "string",
      "type": "string",
      "description": "string",
      "label": "string",
      "members_count": 0,
      "email": "string",
      "aliases": [
        "string"
      ],
      "removed": true,
      "member_of": [
        {
          "id": 0
        }
      ],
      "created_at": "string"
    }
  ]
}

Неуспешный ответ

Ошибки могут быть со следующими HTTP-статусами:

400 Bad Request — параметры запроса не заданы или заданы неверно;
401 Unauthorized — пользователь не авторизован;
403 Forbidden — у пользователя или приложения нет прав на доступ к списку пользователей;
404 Not Found — запрашиваемая организация не найдена;
500 Internal Server Error — ошибка произошла на стороне сервера (в этом случае попробуйте повторно отправить запрос через некоторое время).

Была ли статья полезна?

Получить список пользователей организации

Получить список подразделений организации