Включить 2FA

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

Примечание

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

Request

POST

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

Path parameters

Name

Description

orgId*

Type: integer<int64>

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

Body

application/json

{
    "duration": 0,
    "logoutUsers": false,
    "validationMethod": "default",
    "scope": "per_domain"
}

Name	Description
duration*	Type: integer<int64> Период (в секундах), в течение которого у пользователя в процессе авторизации есть возможность отложить настройку двухфакторной аутентификации. По истечении этого периода возможность отложить настройку отключается.
logoutUsers	Type: boolean Признак, что при включении двухфакторной аутентификации необходимо закрыть сессии всех пользователей домена. Возможные значения: `true` — закрыть сессии всех пользователей. Если использовались пароли приложений, потребуется создать их заново. `false` — не закрывать сессии пользователей.
scope	Type: string Параметр, который определяет, в каком режиме нужно включить двухфакторную аутентификацию. Возможные значения: `per_domain` — сразу всем пользователям с аккаунтами на домене организации. `per_user` — только отдельным сотрудникам. После включения двухфакторной аутентификации в режиме `per_user` настроить ее для конкретных сотрудников можно с помощью метода, описанного в разделе Изменить статус персональной 2FA. Default: `per_domain` Enum: `per_domain`, `per_user`
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",
    "scope": "string"
}

Name	Description
duration	Type: integer<int64> Период (в секундах), в течение которого у пользователя в процессе авторизации есть возможность отложить настройку двухфакторной аутентификации. По истечении этого периода возможность отложить настройку отключается.
enabled	Type: boolean Статус обязательной двухфакторной аутентификации: `true` — включена; `false` — выключена.
enabledAt	Type: string<date-time> Дата и время, когда была включена двухфакторная аутентификация.
scope	Type: string Режим двухфакторной аутентификации: `per_domain` — сразу всем пользователям с аккаунтами на домене организации; `per_user` — только отдельным сотрудникам. У кого именно из сотрудников настроен признак необходимости прохождения 2FA, если она включена в организации, можно узнать с помощью метода, описанного в разделе Посмотреть статус персональной 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

Обзор