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

Возвращает список групп организации: всех или с заданным статусом обязательной двухфакторной аутентификации. Фильтрация по статусу двухфакторной аутентификации находится в разработке. Метод также позволяет найти группу по адресу рассылки.

Отправить запрос может администратор организации или сотрудник с ролью Менеджер пользователей.

Для выполнения запроса требуется одно из перечисленных прав: directory:read_groups или directory:write_groups.

Request

GET

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

Path parameters

Name

Description

org_id

Type: integer

Идентификатор организации.

Query parameters

Name	Description
email	Type: string Адрес рассылки, по которому будут отфильтрованы группы. Example: `team@example.com`
is_2fa_enabled	Type: boolean Статус обязательной двухфакторной аутентификации для группы. Возможные значения: `true` — включена; `false` — выключена.
limit	Type: integer Максимальное количество записей в ответе.
offset	Type: integer Смещение, с которого начинается выборка данных. Поддерживаются только значения `offset`, кратные значению `limit`.

Responses

200 OK

Список групп организации получен.

Body

application/json

{
  "limit": 20,
  "offset": 0,
  "total": 12,
  "items": [
    {
      "id": 7654321,
      "name": "Команда разработки",
      "type": "generic",
      "description": "Группа сотрудников отдела разработки.",
      "label": "development-team",
      "members_count": 12,
      "email": "team@example.com",
      "default_email": "team@example.com",
      "aliases": [
        "developers"
      ],
      "external_id": "group-123",
      "removed": false,
      "member_of": [
        {
          "id": 7654322
        }
      ],
      "created_at": "2026-05-01T10:00:00+00:00",
      "is_2fa_enabled": true
    }
  ]
}

Name	Description
items	Type: GroupsItems Список групп, отфильтрованных по адресу рассылки. Example `[ { "id": 7654321, "name": "Команда разработки", "type": "generic", "description": "Группа сотрудников отдела разработки.", "label": "development-team", "members_count": 12, "email": "team@example.com", "default_email": "team@example.com", "aliases": [ "developers" ], "external_id": "group-123", "removed": false, "member_of": [ { "id": 7654322 } ], "created_at": "2026-05-01T10:00:00+00:00", "is_2fa_enabled": true } ]`
limit	Type: integer Максимальное количество записей в ответе.
offset	Type: integer Смещение, с которого начинается выборка данных.
total	Type: integer Общее количество записей, подходящих по параметрам запроса.

MemberOfItem

Родительская группа, в которую входит текущая группа.

Name

Description

Type: integer

Идентификатор группы.

Example

{
  "id": 7654322
}

MemberOf

Родительские группы, в которые входит текущая группа.

Type: MemberOfItem[]

Example

[
  {
    "id": 7654322
  }
]

Group

Данные группы.

Name	Description
aliases	Type: string[] Алиасы почтовых рассылок группы. Example `[ "developers" ]`
created_at	Type: string Дата и время создания группы. Example: `2026-05-01T10:00:00+00:00`
default_email	Type: string Адрес, используемый по умолчанию. Example: `team@example.com`
description	Type: string Описание группы. Example: `Группа сотрудников отдела разработки.`
email	Type: string Адрес рассылки, по которому будут отфильтрованы группы. Example: `team@example.com`
external_id	Type: string Произвольный внешний идентификатор группы. Example: `group-123`
id	Type: integer Идентификатор группы.
is_2fa_enabled	Type: boolean Статус обязательной двухфакторной аутентификации для группы. Возможные значения: `true` — включена; `false` — выключена.
label	Type: string Имя почтовой рассылки группы. Example: `development-team`
member_of	Type: MemberOf Родительские группы, в которые входит текущая группа. Example `[ { "id": 7654322 } ]`
members_count	Type: integer Количество участников группы.
name	Type: string Название группы. Example: `Команда разработки`
removed	Type: boolean Признак удаленной группы: true — группа удалена; false — группа действующая.
type	Type: string Тип группы. Возможные значения: `generic` — стандартная группа, созданная одним из сотрудников организации. Пользователи могут изменять параметры такой группы и ее состав. `organization_admin` — группа администраторов организации. Неизменяемая техническая группа. `robots` — группа роботов. Неизменяемая техническая группа. `organization_deputy_admin` — группа менеджеров организации. Неизменяемая техническая группа." Example: `generic`

Example

{
  "id": 7654321,
  "name": "Команда разработки",
  "type": "generic",
  "description": "Группа сотрудников отдела разработки.",
  "label": "development-team",
  "members_count": 12,
  "email": "team@example.com",
  "default_email": "team@example.com",
  "aliases": [
    "developers"
  ],
  "external_id": "group-123",
  "removed": false,
  "member_of": [
    {
      "id": 7654322
    }
  ],
  "created_at": "2026-05-01T10:00:00+00:00",
  "is_2fa_enabled": true
}

GroupsItems

Список групп, отфильтрованных по адресу рассылки.

Type: Group[]

Example

[
  {
    "id": 7654321,
    "name": "Команда разработки",
    "type": "generic",
    "description": "Группа сотрудников отдела разработки.",
    "label": "development-team",
    "members_count": 12,
    "email": "team@example.com",
    "default_email": "team@example.com",
    "aliases": [
      "developers"
    ],
    "external_id": "group-123",
    "removed": false,
    "member_of": [
      {
        "id": 7654322
      }
    ],
    "created_at": "2026-05-01T10:00:00+00:00",
    "is_2fa_enabled": true
  }
]

403 Forbidden

Доступ к ресурсу запрещен. У пользователя или приложения недостаточно прав.

Body

application/json

{
  "error": "forbidden",
  "description": "Forbidden",
  "message": "Forbidden",
  "details": {}
}

Name

Description

description

Type: string

Техническое описание ошибки.

Example: Forbidden

error

Type: string

Код ошибки

Example: forbidden

message

Type: string

Сообщение об ошибке.

Example: Forbidden

details

Type: object

Дополнительные детали ошибки

Example

{}

404 Not Found

Запрашиваемый ресурс не найден.

Body

application/json

{
  "error": "not_found",
  "description": "Not found",
  "message": "Not found",
  "details": {}
}

Name

Description

description

Type: string

Техническое описание ошибки.

Example: Not found

error

Type: string

Код ошибки

Example: not_found

message

Type: string

Сообщение об ошибке.

Example: Not found

details

Type: object

Дополнительные детали ошибки

Example

{}

422 Unprocessable Entity

Возможные ошибки:

Feature unavailable
Invalid data

Body

application/json

{
  "error": "feature_unavailable",
  "description": "Feature unavailable",
  "message": "Feature unavailable",
  "details": {}
}

Name

Description

description

Type: string

Техническое описание ошибки.

Example: Feature unavailable

error

Type: string

Код ошибки

Example: feature_unavailable

message

Type: string

Сообщение об ошибке.

Example: Feature unavailable

details

Type: object

Дополнительные детали ошибки

Example

{}

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

Изменить параметры сотрудника

Получить информацию о группе