Breadcrumbs

Создание метода MFA

Метод используется для создания метода MFA для текущего пользователя. Метод возвращает набор из 10 одноразовых кодов, которые текущий пользователь может использовать для входа в Панель управления Клиента вместо созданного метода MFA. Код ответа 201 Created.

Перед вызовом метода необходимо получить параметры для настройки метода MFA (см. Создание параметров для настройки метода MFA).

POST {reseller_domain}/internal_api/mfa/create

В этой статье:

Авторизация

Требуется авторизация с помощью access token пользователя.

Аргументы

Название

Тип параметра

Тип данных

Обязательный/ 
Опциональный

Описание

Content-Type

header

string

Обязательный

Тип данных, передаваемых в запросе. Укажите application/vnd.api+json

Accept

header

string

Обязательный

Поддерживаемые типы данных в ответе. Укажите application/vnd.api+json

X-Api-Locale

header

string

Опциональный

Двухбуквенный код языка данных в ответе

Authorization 

header

string

Обязательный

Действующий access token пользователя. Формат: Bearer <access token>

reseller_domain

path

string

Обязательный

Доменное имя реселлера

key

form

string

Обязательный

Ключ создаваемого метода MFA. Укажите тот же ключ, что и при вызове

Создание параметров для настройки метода MFA

params

form

object

Обязательный

Параметры создаваемого метода MFA


code

form

string

Обязательный

Код, сгенерированный методом MFA (например, временный код, отображаемый в приложении для аутентификации)


default

form

bool

Обязательный

Признак метода MFA, используемого по умолчанию:

  • true — признак установлен, метод MFA будет использоваться по умолчанию. При создании первого метода MFA для пользователя укажите true.

  • false — признак не установлен, код MFA не будет использоваться по умолчанию.


manual_secret

form

string

Обязательный

Код для ручной настройки метода MFA, полученный при вызове 

Создание параметров для настройки метода MFA

Модель ответа

Модель ответа аналогична методу Создание резервных кодов.

Пример запроса

Bash
curl --location --request POST 'https://test.activeplatform.com/internal_api/mfa/create' \
--header 'Content-Type: application/vnd.api+json' \
--header 'Accept: application/vnd.api+json' \
--header 'X-Api-Locale: en' \
--header 'Authorization: Bearer AccessTokenExample' \
--data-raw '{
    "data": {
        "attributes": {
            "key": "authenticator",
            "params": {
                "code": "123456",
                "default": true,
                "manual_secret": "ABC123"
            }
        }
    }
}'

Пример ответа

JSON
{
    "backup_codes": [
        "b4c3da4f",
        "48a330cf",
        "7e3558ee",
        "676bd770",
        "661bcdfb",
        "7ada89f9",
        "800734a1",
        "73864b07",
        "88a55dd0",
        "76923f9e"
    ]
}