Skip to main content

Изменение настроек проверочного кода

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

PUT /tenants/{tenant_name}/captcha_settings

Описание​

Позволяет изменить настройки для капчи тенанта.

Параметры​

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

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

Запрос​

curl -X 'PUT' $LOGIN_TOKEN \
"https://admin[-<ENV>].<DEFAULT_DOMAIN>/adminapi/\
tenants/<TENANT_NAME>/captcha_settings\
-d captcha_settings='{"bruteForceProtected": true, \
"failureFactor": 0, "maxDeltaTimeSeconds": 0,\
"minimumQuickLoginWaitSeconds": 0, "permanentLockout": true, \
"quickLoginCheckMilliseconds": 0, "waitIncrementSeconds": 0}' \
-H 'accept: application/json'

где:

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

  • captcha_settings — настройки для работы с капчей в тенанте:

Ответ​

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

  • 200 — Success — Успешно. Пример вывода:
{
"id": "string",
"name": "string"
"captcha_settings": {
"bruteForceProtected": true,
"failureFactor": 0,
"maxDeltaTimeSeconds": 0,
"minimumQuickLoginWaitSeconds": 0,
"permanentLockout": true,
"quickLoginCheckMilliseconds": 0
"waitIncrementSeconds": 0,
},
}
  • 400 — Auth header is not provided or token is invalid — Не указан параметр авторизации или неверный токен. Пример вывода:
{
"message": "string"
}
  • 404 — Tenant not found — Тенант не найден. Пример вывода:
{
"message": "string"
}