Перечень пользователей
Метод и конечная точка
GET /tenants/{tenant_name}/users
Описание
Выводит перечень пользователей.
Параметры
Параметры для метода указаны в таблице.
| Название | Обязательный | Тип данных | Описание |
|---|---|---|---|
| query | нет | string | Поисковый запрос, в соответствии с которым выполняется поиск (если параметр не установлен, выводится полный список групп) |
| role | нет | string | Роль пользователя из перечня доступных ролей в текущем тенанте |
| enabled | нет | string | Если этот параметр указан, то пользователь будет разблокирован (сможет войти в систему), если он был заблокирован ранее |
| limit | нет | string | Ограничение поиска |
| offset | нет | string | япараметр настройки выдачи результатов поиска |
| start_ctime | нет | string | Начало диапазона времени для фильтрации пользователей, отметка времени unix в миллисекундах |
| end_ctime | нет | string | Окончание диапазона времени для фильтрации пользователей, отметка времени unix в миллисекундах |
| sort_field | нет | string | Допустимые поля сортировки: ctime, used_bytes, first_name, middle_name, position, last_name, username, email, password_expiration, enabled, role |
| sort_type | нет | string | Тип сортировки результатов выдачи, может принимать значения asc или`desc |
| with_deleted | нет | string | Отображать удаленных пользователей, если значение параметра True |
| status | нет | string | Фильтрация по статусу; доступные значения active, blocked, deleted |
| with_prohibited_ctypes | нет | string | Запрос вывода пользователей с указанием запрещенных медиатипов |
| has_deleted_files | нет | string | Запрос вывода пользователей с удаленными файлами |
| tenant_name | да | string | Имя тенанта |
Запрос
curl -X 'GET' $LOGIN_TOKEN \
"https://admin[-<ENV>].<DEFAULT_DOMAIN>/adminapi/\
tenants/<TENANT_NAME>/users?query=<QUERY>&role=<ROLE>&\
enabled=<ENABLED>&limit=<LIMIT>&offset=<OFFSET>&start_ctime=<START_CTIME>&\
end_ctime=<END_CTIME>&sort_field=<SORT_FIELD>&\
sort_type=<SORT_TYPE>&with_deleted=<WITH_DELETED>&status=<STATUS>&\
with_prohibited_ctypes=<WITH_PROHIBITED_CTYPES>&has_deleted_files=<HAS_DELETED_FILES>" \
-H 'accept: application/json'
где:
<TENANT_NAME>— имя тенанта;<QUERY>— поисковый запрос. Если этот параметр установлен, то поиск осуществляется в соответствии со значением. Если параметр не установлен, выводится полный список всех групп;<ROLE>— роль пользователя из перечня доступных ролей в текущем тенанте;<ENABLED>— если этот параметр указан, то пользователь будет разблокирован (сможет войти в систему), если он был заблокирован ранее;<LIMIT>— ограничения поиска;<OFFSET>— параметр настройки выдачи результатов поиска;<START_CTIME>— начало диапазона времени для фильтрации пользователей, отметка времени unix в миллисекундах;<END_CTIME>— окончание диапазона времени для фильтрации пользователей, отметка времени unix в миллисекундах;<SORT_FIELD>— допустимые поля сортировки;<SORT_TYPE>— тип сортировки результатов выдачи;<WITH_DELETED>— отображать удаленных пользователей, если значение параметра True;<STATUS>— фильтрация по статусу;<WITH_PROHIBITED_CTYPES>— запрос вывода пользователей с указанием запрещенных медиатипов;<HAS_DELETED_FILES>— запрос вывода пользователей с удаленными файлами.
Ответ
Возможные варианты ответов:
- 200 — Success — Успешно. Пример вывода:
{
"count": 0,
"users": [
{
"ctime": "string",
"domain": "string",
"enabled": true,
"except_ctype_prohibition": true,
"first_name": "string",
"id": "string",
"is_deleted": true,
"lang": "string",
"last_name": "string",
"middle_name": "string",
"password": "string",
"position": "string",
"quota": 0,
"recovery_email": "string",
"roles": [
{
"clientRole": true,
"composite": true,
"containerId": "string",
"description": "string",
"id": "string",
"name": "string"
}
],
"username": "string"
}
],
"users_count": 0
}
- 404 — Tenant not found — Тенант не найден. Пример вывода:
{
"message": "string"
}