Skip to main content

Перечень тенантов

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

GET /tenants

Описание​

Выводит перечень тенантов.

Параметры​

Параметры для метода указаны в таблице.

НазваниеОбязательныйТип данныхОписание
queryнетstringЕсли этот параметр установлен, то поиск осуществляется в соответствии со значением, если параметр не установлен, выводится полный список всех тенантов
pageнетstringПараметр для разделения вывода на страницы. Размер страницы — 50 строк

Запрос​

curl -X 'GET' $LOGIN_TOKEN \
"https://admin[-<ENV>].<DEFAULT_DOMAIN>/adminapi/\
tenants?query=<QUERY>?page=<PAGE>" \
-H 'accept: application/json'

Где:

  • <QUERY> — параметр условий поиска;

  • <PAGE> — параметр, задающий разделение вывода на страницы;

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

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

Ответ​

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

  • 200 — Success — Успешно. Пример вывода:
{
"tenants": [
{
"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
}
]
}