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

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

GET/tenants/{tenant_name}/two_fa_settings

Описание

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

Параметры

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

Название	Обязательный	Тип данных	Описание
tenant_name	да	string	Имя тенанта

Запрос

curl -X 'GET' $LOGIN_TOKEN \
"https://admin[-<ENV>].<DEFAULT_DOMAIN>/adminapi/\
tenants/<TENANT_NAME>/two_fa_settings" \
-H 'accept: application/json'

Ответ

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

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

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

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

{
"message": "string"
}

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

{
"message": "string"
}