Изменить статус 2FA для группы (в разработке)

Изменяет статус обязательной двухфакторной аутентификации для группы. Чтобы изменить остальные параметры группы, воспользуйтесь запросом Изменить параметры группы на хост api360.yandex.net.

Этот инструмент доступен в тарифах для крупных организаций Корпоративный + Безопасность и Корпоративный Максимум. Чтобы узнать подробности, оставьте заявку: менеджер Яндекс 360 свяжется с вами, ответит на все вопросы и поможет с подключением. Оставить заявку

Метод актуален, если:

В организации установлена двухфакторная аутентификация через сервис для управления 2FA (v2) с возможностью персональной настройки или в интерфейсе Кабинета организации.
Режим двухфакторной аутентификации scope: per_user — только отдельным сотрудникам. Узнать режим, который установлен для 2FA в вашей организации, можно с помощью метода, описанного в разделе Посмотреть статус 2FA с возможностью персональной настройки.

Особенности обязательной 2FA для группы

На кого распространяется

Статус 2FA действует только на участников группы с аккаунтами на домене организации:

Начинает действовать при вступлении сотрудника в группу.
Перестаёт действовать после удаления сотрудника из группы.
Не распространяется на вложенные группы — для них нужно задавать статус отдельно.

Как работает с персональной 2FA

Статус 2FA для группы не изменяет персональную настройку 2FA у сотрудников:

Если для группы установлено is_2fa_enabled=true, сотрудники будут обязаны проходить 2FA.
При этом методы, возвращающие персональный статус 2FA, по-прежнему будут показывать is_2fa_enabled=false для этих сотрудников.

Правила применения 2FA

Сотрудник обязан проходить 2FA, если хотя бы один из параметров is_2fa_enabled имеет значение true:

Персональная настройка 2FA.
Настройка 2FA для подразделения.
Настройка 2FA хотя бы для одной из групп, в которых состоит сотрудник.

Примечание

Чтобы выполнить запрос, приложению требуется разрешение directory:write_groups — просмотр и изменение данных групп.

Запрос

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

Path-параметры

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

Заголовки

Authorization: OAuth <токен>
Content-Type: application/json

Тело

Имя параметра

Тип

Описание

is_2fa_enabled

boolean

Статус обязательной двухфакторной аутентификации для группы.

Возможные значения:

true — включена;
false — выключена.

Пример

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

curl -X PATCH -H "Authorization: OAuth <токен>" -H "Content-Type: application/json" -d '{"is_2fa_enabled": true}' "https://cloud-api.yandex.net/v1/directory/organizations/1/groups/2"

Ответ

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

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

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

Поле	Тип	Описание
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` — группа менеджеров организации. Неизменяемая техническая группа.
is_2fa_enabled	boolean	В разработке Статус обязательной двухфакторной аутентификации для группы: `false` — выключена (по умолчанию); `true` — включена.

Пример

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

{
  "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",
  "is_2fa_enabled": false
}

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

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

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

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

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

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