Изменение параметров двухфакторной авторизации в тенанте

Метод и конечная точка

PUT /tenants/{tenant_name}/two_fa_settings

Описание

Позволяет изменить размеры параметры двухфакторной авторизации в тенанте.

Параметры

Перечень параметров представлен в таблице.

Название	Обязательный	Тип данных	Описание
two_fa_settings	нет	string	Параметр для изменения парольных политик в тенанте
tenant_name	да	string	Имя тенанта
status	да	bolean	Включение/выключение двухфакторной авторизации
type	да	string	Тип двухфакторной авторизации
digits	да	integer	Длина одноразового пароля. Принимает значения 6 или 8
algorithm	да	string	алгоритм шифрования секрета Принимает значения: SHA-1 / SHA-256 / SHA-512
sync_step	да	integer	Максимальное количество попыток ввода пароля. Принимает значения: от 5 до 10
period_time	да	integer	Время жизни одноразового пароля в секундах. Принимает значения: от 1 до 300
user_groups	да	string	Для каких групп пользователей включить 2Ф. Принимает значения: user и/или admin

Запрос

curl -X 'PUT' $LOGIN_TOKEN \
"https://admin[-<ENV>].<DEFAULT_DOMAIN>/adminapi/\
tenants/<TENANT_NAME>/two_fa_settings" \
-d two_fa_settings='{"status": "0", "digits": "6", \
"algorithm": "SHA1", "sync_step": "5", \
"period_time": "30", "type": "TOTP", \
"user_groups": ["user", "admin"]}' \
-H 'accept: application/json'

где:

• <TENANT_NAME> — имя настраиваемого тенанта;

• two_fa_settings — настройки для работы с двухфакторной авторизацией в тенанте.

Ответ

Возможные варианты ответов:

• 200 — Success — Успешно. Пример вывода:

{
"id": "string",
"name": "string"
"two_fa_settings": {
"digits": 6,
"algorithm": "SHA1",
"status": 0,
"period_time": 30,
"sync_step": 5,
"type": "HOTP",
"user_groups": [
"user",
"admin"
]
}
}

• 401 — Auth header is not provided or token is invalid — Не указан параметр авторизации или некорректный токен. Пример вывода:

{
"message": "string"
}

• 404 — Tenant not found — Тенант не найден. Пример вывода:

{
"message": "string"
}