Посмотр статуса 2FA

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

В ответе метод вернет параметр enabled со значением true, если на домене настроен enforcement_mode=per_domain и администратор подключил принудительную 2FA всем пользователям.

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

Request

GET

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

Path parameters

Name

Description

org_id

Type: integer

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

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`

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

{}

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

Обзор

Изменить статус