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

Метод используется для создания параметров, необходимых текущему пользователю для создания или сброса метода MFA. Код ответа 200 OK.

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

POST {reseller_domain}/internal_api/mfa/generate_settings

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

Авторизация

Требуется авторизация с помощью 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 см. в `mfa_available_methods` в Получение настроек реселлера , а список настроенных методов MFA текущего пользователя см. в `mfa_enabled_methods` в Получение информации о текущем пользователе )
params		form	object	Опциональный	Параметры для настройки метода MFA. Указываются только для последующего сброса ранее настроенного метода MFA текущего пользователя (см. Сброс метода MFA )
	code	form	string	Опциональный	Код, сгенерированный выбранным методом MFA (например, временный код, отображаемый в приложении для аутентификации)

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

Название		Тип данных	Описание
mfa_settings		object	Параметры для настройки метода MFA
	url	string	Ссылка для QR-кода
	manual_secret	string	Код для ручной настройки метода MFA
meta		object	Дополнительная информация
	server_current_time	string	Текущие дата и время сервера

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

Bash

curl --location --request POST 'https://test.activeplatform.com/internal_api/mfa/generate_settings' \
--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"
        }
    }
}'

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

JSON

{
    "mfa_settings": {
    	"manual_secret": "ABC123",
    	"url": "otpauth://totp/XXX"
  	},
    "meta": {
        "server_current_time": "2023-06-30 T12:34:56.199973+0300"
    }
}