Включить 2FA

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

Примечание

Чтобы выполнить запрос, приложению требуется разрешение на управление обязательной 2FA для пользователей. Убедитесь, что вы включили его при настройке приложения на OAuth-сервере Яндекса.

Request

POST

https://api360.yandex.net/security/v1/org/{orgId}/domain_2fa

Path parameters

Name

Description

orgId*

Type: integer<int64>

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

Body

application/json
{
    "duration": 0,
    "logoutUsers": false,
    "validationMethod": "default"
}

Name

Description

duration*

Type: integer<int64>

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

logoutUsers

Type: boolean

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

validationMethod

Type: string

Метод, которым будет проверяться второй фактор:

  • default — использовать метод проверки, заданный в алгоритмах Яндекс ID в качестве приоритетного.
  • phone — определять итоговый метод проверки с помощью алгоритмов Яндекс ID, но отдавать по возможности предпочтение звонку на телефон.

Default: default

Enum: default, phone

Responses

200 OK

Запрос успешно выполнен.

Body

application/json
{
    "enabled": false,
    "duration": 0,
    "enabledAt": "2022-12-29T18:02:01Z"
}

Name

Description

duration

Type: integer<int64>

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

enabled

Type: boolean

Статус обязательной 2FA: true — включена; false — выключена.

enabledAt

Type: string<date-time>

Время включения 2FA.

401 Unauthorized

Пользователь не авторизован.

Body

application/json
{
    "code": 0,
    "message": "string",
    "details": [
        null
    ]
}

Name

Description

code

Type: integer<int32>

Код ошибки.

details

Type: any[]

Дополнительные сведения об ошибке.

message

Type: string

Описание ошибки.

403 Forbidden

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

Body

application/json
{
    "code": 0,
    "message": "string",
    "details": [
        null
    ]
}

Name

Description

code

Type: integer<int32>

Код ошибки.

details

Type: any[]

Дополнительные сведения об ошибке.

message

Type: string

Описание ошибки.

404 Not Found

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

Body

application/json
{
    "code": 0,
    "message": "string",
    "details": [
        null
    ]
}

Name

Description

code

Type: integer<int32>

Код ошибки.

details

Type: any[]

Дополнительные сведения об ошибке.

message

Type: string

Описание ошибки.

500 Internal Server Error

Внутренняя ошибка сервиса. Попробуйте повторно отправить запрос через некоторое время.

Body

application/json
{
    "code": 0,
    "message": "string",
    "details": [
        null
    ]
}

Name

Description

code

Type: integer<int32>

Код ошибки.

details

Type: any[]

Дополнительные сведения об ошибке.

message

Type: string

Описание ошибки.
Предыдущая
Выключить 2FA
Следующая
Обзор