Изменение статуса 2FA

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

Для выполнения запроса требуется право ya360_security:domain_2fa_write.

Request

PUT

https://cloud-api.yandex.net/v1/directory/organizations/{org_id}/settings/2fa

Path parameters

Name

Description

org_id

Type: integer

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

Body

application/json
{
  "enabled": true,
  "setup_grace_period_seconds": 604800,
  "enforcement_mode": "per_domain",
  "second_factor_type": "phone",
  "preferred_phone_validation_method": "default"
}

Name

Description

enabled

Type: boolean

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

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

enforcement_mode

Type: string

Режим обязательной двухфакторной аутентификации:

  • per_user — для отдельных сотрудников;
  • per_domain — для всех сотрудников с аккаунтами на домене организации.

Параметр обязателен при enabled=true.

Enum: per_user, per_domain

preferred_phone_validation_method

Type: string

Способ аутентификации через Яндекс ID, если в параметре second_factor_type выбран phone:

  • default — определяется автоматически;
  • call — звонок по номеру телефона.

Enum: default, call

second_factor_type

Type: string

Способ аутентификации:

  • phone — через Яндекс ID;
  • totp — через приложение для создания одноразовых паролей, например Яндекс Ключ.

Enum: phone, totp

setup_grace_period_seconds

Type: integer

Период в секундах, в течение которого сотрудник может отложить настройку 2FA. Обязателен при enabled=true.

Максимальный период — шесть месяцев (16070400 секунд).

Min value: 1

Max value: 16070400

Responses

200 OK

Настройки обновлены.

Body

application/json
{
  "enabled": true,
  "setup_grace_period_seconds": 604800,
  "enabled_at": "2026-05-01T10:00:00+00:00",
  "enforcement_mode": "per_domain",
  "second_factor_type": "phone",
  "preferred_phone_validation_method": "default"
}

Name

Description

enabled

Type: boolean

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

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

enabled_at

Type: string<date-time>

Дата и время, когда была включена двухфакторная аутентификация, например 2026-04-22T07:52:11+00:00, если в параметре enforcement_mode выбран per_domain.

Example: 2026-05-01T10:00:00+00:00

enforcement_mode

Type: string

Режим двухфакторной аутентификации:

  • per_domain — для всех сотрудников с аккаунтами на домене организации;
  • per_user — для отдельных сотрудников.

Enum: per_user, per_domain

preferred_phone_validation_method

Type: string

Способ аутентификации через Яндекс ID, если в параметре second_factor_type выбран phone:

  • default — определяется автоматически;
  • call — звонок по номеру телефона.

Enum: default, call

second_factor_type

Type: string

Способ аутентификации:

  • phone — через Яндекс ID;
  • totp — через приложение для создания одноразовых паролей, например Яндекс Ключ.

Enum: phone, totp

setup_grace_period_seconds

Type: integer

Период (в секундах), в течение которого у пользователя в процессе авторизации есть возможность отложить настройку двухфакторной аутентификации, например 3600. По истечении этого периода возможность отложить настройку отключается.

Максимальный период — 6 месяцев (16070400).

Min value: 1

Max value: 16070400

400 Bad Request

Некорректный запрос.

Body

application/json
{
  "error": "bad_request",
  "description": "Bad request",
  "message": "Bad request",
  "details": {}
}

Name

Description

description

Type: string

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

Example: Bad request

error

Type: string

Код ошибки

Example: bad_request

message

Type: string

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

Example: Bad request

details
Type: object

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

Example
{}

403 Forbidden

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

  • Authorization error
  • SSO user default email change is prohibited
  • SSO user personal info change is prohibited

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
{}

409 Conflict

2FA management is not enabled for this organization

Body

application/json
{
  "error": "feature_disabled",
  "description": "2FA management is not enabled for this organization",
  "message": "2FA management is not enabled for this organization",
  "details": {}
}

Name

Description

description

Type: string

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

Example: 2FA management is not enabled for this organization

error

Type: string

Код ошибки

Example: feature_disabled

message

Type: string

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

Example: 2FA management is not enabled for this organization

details
Type: object

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

Example
{}

422 Unprocessable Entity

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

  • Invalid data
  • Missing required field
  • Invalid field value
  • Invalid request body
  • Default email must be one of the user's existing emails
  • Invalid default email
  • Default email cannot be empty
  • Invalid display name
  • Display name cannot be empty
  • Cannot disable 2FA while users with enabled 2FA remain

Body

application/json
{
  "error": "invalid_data",
  "description": "Invalid data",
  "message": "Invalid data",
  "details": {}
}

Name

Description

description

Type: string

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

Example: Invalid data

error

Type: string

Код ошибки

Example: invalid_data

message

Type: string

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

Example: Invalid data

details
Type: object

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

Example
{}
Предыдущая
Посмотреть статус
Следующая
Закрыть сессии всех пользователей