Получение списка общих папок в тенанте

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

GET /tenants/{tenant_name}/corporate

Описание

Позволяет получить список общих папок в тенанте.

Параметры

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

Название	Обязательный	Тип данных	Описание
offset	нет	string	Параметр настройки выдачи результатов поиска
limit	нет	string	Ограничения поиска
query	да	string	Поисковый запрос, в соответствии с которым выполняется поиск (если параметр не установлен, выводится полный список папок)
sort_order	нет	string	Порядок сортировки результатов выдачи, может принимать значения asc или desc
sort_by	нет	string	Сортировать по параметрам, допустимые поля сортировки: admin, size, id, name.
tenant_name	да	string	Имя тенанта

Запрос

curl -X 'GET' $LOGIN_TOKEN \
"https://admin[-<ENV>].<DEFAULT_DOMAIN>/adminapi/\
tenants/<TENANT_NAME>/corporate?query=<QUERY>&offset=<OFFSET>&\
limit=<LIMIT>&sort_order=<SORT_ORDER>&sort_by=<SORT_BY>" \
-H 'accept: application/json'

где:

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

• <QUERY>— поисковый запрос. Если этот параметр установлен, то поиск осуществляется в соответствии со значением. Если параметр не установлен, выводится полный список всех групп;

• <LIMIT> — ограничения поиска;

• <OFFSET> — параметр настройки выдачи результатов поиска;

• <SORT_ORDER> — порядок сортировки результатов поиска;

• <SORT_BY> — сортировка по указанному параметру.

Ответ

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

• 200 — Success — Успешно. Пример вывода:

{
"corp_folders": [
 {
"id": 0,
 "name": "string",
 "quota_size": 0,
 "size": 0,
 "admin_username": "string",
 "admin_id": "string",
 "first_name": "string",
 "last_name": "string",
 "admin_email": "string",
 },
 ]
}

• 404 — Tenant not found — Тенант не найден. Пример вывода:

{
"message": "string"
}