Перечень групп пользователей

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

GET /tenants/{tenant_name}/groups

Описание

Запрос перечня существующих групп.

Параметры

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

Название	Обязательный	Тип данных	Описание
query	нет	string	Поисковый запрос. Если этот параметр установлен, то поиск осуществляется в соответствии со значением. Если параметр не установлен, выводится полный список всех групп
limit	нет	string	Ограничения поиска
offset	нет	string	Параметр настройки выдачи результатов поиска
with_ctypes	нет	string	Перечень запретов на загрузку файлов определенных типов для группы
exact	да	string	Точный поисковый запрос
tenant_name	да	string	Имя тенанта

Запрос

curl -X 'GET' $LOGIN_TOKEN \
"https://admin[-<ENV>].<DEFAULT_DOMAIN>/adminapi/\
tenants/<TENANT_NAME>/groups?query=<QUERY>&limit=<LIMIT>&offset=<OFFSET>&\
with_ctypes=<WITH_CTYPES>&exact=<EXACT>" \
-H 'accept: application/json'

где:

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

• <QUERY> — поисковый запрос;

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

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

• <WITH_CTYPES> — возможность работы с файлами в соответствии с правилами для определенных медиатипов;

• <EXACT> — точный поисковый запрос.

Ответ

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

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

{
"groups": [
{
"ctypes": [
{
"grouped_ctype": "string",
"prohibited": true
}
],
"id": 0,
"name": "string",
"subgroups": [
{
"id": 0,
"name": "string"
}
],
"users":[
{
"first_name": "string",
"id": "string",
"last_name": "string",
"middle_name": "string",
"username": "string"
}
]
}
]
}

• 400 — File or user do not belong to current tenant — Файл или пользователь не найдены в текущем тенанте. Пример вывода:

{
"message": "string"
}

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

{
"message": "string"
}