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

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

PUT /tenants/{tenant_name}/common-settings

Описание

Отправляет обновление значений параметров настроек тенанта. Метод может одновременно обрабатывать все указанные в запросе параметры.

Параметры

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

Название	Обязательный	Тип данных	Описание
max_users	нет	integer	Максимальное количество пользователей тенанта
enable_recovery_email	нет	string	Включить/выключить recovery_email
excluded_locales	нет	string	Включить/выключить excluded_locales
ctypes_prohibition_ enabled	нет	string	Включить/выключить ctypes_prohibition
lang	нет	string	Изменить основной язык тенанта
autolock_users_ enabled	нет	string	Включить/выключить автоматическую блокировку пользователей в тенанте
users_session_ duration	нет	string	Длительность пользовательской сессии в тенанте
signature_enabled	нет	string	Включить/выключить цифровую подпись для пользователя в тенанте
security_notification_ enabled	нет	string	Включить/выключить уведомления безопасности в тенанте
files_notifications_ enabled	нет	string	Включить/выключить уведомления о размере файлов в тенанте
tenant_name	да	string	Имя тенанта

Запрос

curl -X 'PUT' $LOGIN_TOKEN \
"https://admin[-<ENV>].<DEFAULT_DOMAIN>/adminapi/\
tenants/<TENANT_NAME>/common-settings?max_users=<MAX_USERS_COUNT>&\
lang=<LANGUAGE>" \
-H 'accept: application/json'

где:

• <TENANT_NAME> — имя тенанта;

• <MAX_USERS_COUNT> — максимальное количество пользователей в тенанте;

• $LOGIN_TOKEN — токен авторизации полученный в разделе Настройка токена авторизации;

• <LANGUAGE> — основной язык тенанта.

Ответ

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

• 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"
}