Включить 2FA

  1. HTTP-запрос
  2. Path-параметры
  3. Тело запроса
    1. Представление
    2. Поля
  4. Ответы
    1. Код 200
      1. Представление
      2. Поля
    2. Код 401
      1. Представление
      2. Поля
    3. Код 403
      1. Представление
      2. Поля
    4. Код 404
      1. Представление
      2. Поля
    5. Код 500
      1. Представление
      2. Поля

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

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

HTTP-запрос

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

Path-параметры

orgId *

integer

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

orgId *

integer

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

Тело запроса

{
  "duration": integer,
  "logoutUsers": boolean,
  "validationMethod": string
}
Скопировано

Представление

Свернуть всё
Развернуть всё

Поля

duration *

integer

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

logoutUsers

boolean

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

validationMethod

string

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

  • sms: SMS.
  • phone: Звонок.

Значение по умолчанию: sms.

Возможные значения
  1. sms
  2. phone

duration *

integer

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

logoutUsers

boolean

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

validationMethod

string

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

  • sms: SMS.
  • phone: Звонок.

Значение по умолчанию: sms.

Возможные значения
  1. sms
  2. phone

Ответы

Код 200

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

{
  "duration": integer,
  "enabled": boolean,
  "enabledAt": string
}
Скопировано

Представление

Свернуть всё
Развернуть всё

Поля

duration *

integer

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

enabled

boolean

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

enabledAt

string

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

duration *

integer

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

enabled

boolean

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

enabledAt

string

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

Код 401

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

{
  "code": integer,
  "details": [
    {
      "@type": string
    }
  ],
  "message": string
}
Скопировано

Представление

Свернуть всё
Развернуть всё

Поля

code

integer

details[]

array

details[].@type

string

message

string

code

integer

details[]

array

details[].@type

string

message

string

Код 403

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

{
  "code": integer,
  "details": [
    {
      "@type": string
    }
  ],
  "message": string
}
Скопировано

Представление

Свернуть всё
Развернуть всё

Поля

code

integer

details[]

array

details[].@type

string

message

string

code

integer

details[]

array

details[].@type

string

message

string

Код 404

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

{
  "code": integer,
  "details": [
    {
      "@type": string
    }
  ],
  "message": string
}
Скопировано

Представление

Свернуть всё
Развернуть всё

Поля

code

integer

details[]

array

details[].@type

string

message

string

code

integer

details[]

array

details[].@type

string

message

string

Код 500

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

{
  "code": integer,
  "details": [
    {
      "@type": string
    }
  ],
  "message": string
}
Скопировано

Представление

Свернуть всё
Развернуть всё

Поля

code

integer

details[]

array

details[].@type

string

message

string

code

integer

details[]

array

details[].@type

string

message

string