Skip to main content

Чтение установленных параметров настроек тенанта

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

GET /tenants/{tenant_name}/common-settings

Описание​

Выводит установленные значения параметров настроек тенанта.

Параметры​

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

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

Запрос​

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

где <TENANT_NAME> — имя тенанта.

Ответ​

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

  • 200 — Success — Успешно. Пример вывода:
{
"ctypes_prohibition_enabled": true,
"enable_recovery_email": true,
"excluded_locales": true,
"id": "string",
"lang": "string",
"max_users": 0,
"name": "string"
}
  • 401 — Auth header is not provided or token is invalid — Не указан параметр авторизации или некорректный токен. Пример вывода:
{
"message": "string"
}
  • 404 — Tenant not found — Тенант не найден. Пример вывода:
{
"message": "string"
}