Создание нового тенанта
Метод и конечная точка
POST /tenants
Описание
Создает новый тенант с заданными параметрами.
Параметры
Параметры для метода указаны в таблице.
| Название | Обязательный | Тип данных | Описание |
|---|---|---|---|
| name | да | string | Имя нового тенанта |
| default_domain | да | string | Имя домена по умолчанию |
| admin_password | да | string | Пароль администратора |
| admin_recovery_email | да | string | Адрес электронной почты для восстановления пароля |
| max_users | нет | string | Максимальное количество пользователей тенанта |
| admin_username | нет | string | Имя пользователя для учетной записи администратора, по умолчанию admin@{default_domain} |
| quota_per_user | нет | integer | Допустимое количество байтов (квота) для документов пользователя. По умолчанию 1 ГБ. |
| tenant_quota | нет | integer | Количество байтов, разрешенное для документов пользователей в этом тенанте |
| tenant_corp_quota | нет | integer | Допустимое количество байтов для корпоративных документов в этом тенанте |
| autoversion_settings | нет | string | Настройка автоматического версионирования в тенанте |
| lang | нет | string | Язык по умолчанию |
| smtp_config | нет | string | Строка JSON со значениями параметров smtp и esia |
Запрос
curl -X 'POST' $LOGIN_TOKEN \
"https://admin[-<ENV>].<DEFAULT_DOMAIN>/adminapi/tenants?\
name=<TENANT_NAME>&default_domain=<DEFAULT_DOMAIN_NAME>&\
admin_password=<ADMIN_PASSWORD>&admin_recovery_email=<ADMIN_RECOVERY_EMAIL>&\
max_user_count=<MAX_USER_COUNT>" \
-H 'accept: application/json'
где:
-
<TENANT_NAME>— имя нового тенанта; -
<DEFAULT_DOMAIN_NAME>— имя домена по умолчанию; -
<ADMIN_PASSWORD>— пароль администратора; -
<ADMIN_RECOVERY_EMAIL>— адрес электронной почты для восстановления пароля; -
$LOGIN_TOKEN— токен авторизации полученный в разделе Настройка токена авторизации. -
<MAX_USER_COUNT>— максимальное количество пользователей тенанта, значение по умолчанию — 1000.
Ответ
Возможные варианты ответов:
- 200 — Success — Успешно. Пример вывода:
{
"autoversion_settings": {
"autoversion_time": 0,
"enable_autoversion": 0,
"max_autoversions": 0
},
"default_domain": "string",
"domains": [
"string"
],
"enable_recovery_email": 0,
"enabled": true,
"enabled_users_count": 0,
"excluded_locales": true,
"history_settings": {
"has_history_events": true,
"history_enabled": true,
"history_events_max_count": 0,
"history_expiration_period": 0,
"history_strategy": "string"
},
"id": "string",
"lang": "string",
"max_users": 0,
"name": "string",
"passwordPolicies": {
"length": 0,
"max_keep_passwords": 0,
"min_digits": 0,
"min_lower_case": 0,
"min_upper_case": 0,
"password_exp_time": 0,
"special_characters": 0
},
"public_link_settings": {
"public_link_access_time_without_password": 0,
"public_link_corp_folders_enabled": true,
"public_link_enabled": true,
"public_link_password_required": true,
"public_link_threshold_attempts_number": 0
},
"security_log_settings": {
"is_protect_data_in_security_log": true,
"is_security_log": true,
"siem_host": "string",
"siem_port": "string",
"siem_protocol": "string"
},
"users_count": 0
}
- 400 — Tenant name or default domain contains space symbols — Имя тенанта или домена по умолчанию содержит символы пробела. Пример вывода:
{
"message": "string"
}
- 409 — Tenant or domain already exists — Тенант или домен уже существуют. Пример вывода:
{
"message": "string"
}