Запрос: GET /users
Оглавление minLevel 2
Права пользователя для выполнения запроса
Владелец аккаунта, Администратор аккаунта, Администратор подразделения, Автор или роль с индивидуальными настройками.
Администратор подразделения, Автор и пользователь с ролью с индивидуальными настройками могут получать список пользователей только тех подразделений, которыми управляют, и вложенных в них подразделений.
Заголовки и параметры запроса
Заголовок | Описание |
---|---|
X-Auth-Account-Url (обязательный) | Базовый URL аккаунта, например, http://myaccount.ispringlearn,ru. |
X-Auth-Email (обязательный) | Логин Владельца аккаунта, Администратора, Администратора подразделения, Автора или пользователя с ролью с индивидуальными настройками. |
X-Auth-Password (обязательный) | Пароль Владельца аккаунта, Администратора, Администратора подразделения, Автора или пользователя с ролью с индивидуальными настройками. |
Параметр | Описание |
departments (необязательный) | Массив ID подразделений, список пользователей которых вы хотите получить. |
groups (необязательный) | Массив ID групп, список пользователей которых вы хотите получить. |
pageSize (необязательный) | Количество записей на 1 страницу. Если не указан, то 1000. |
pageToken (необязательный) | Токен для перехода на следующую страницу. |
Права пользователя для выполнения запроса
Владелец аккаунта, Администратор аккаунта, Администратор подразделения, Автор или роль с индивидуальными настройками.
...
Параметры ответа
Параметр | Описание |
---|---|
userProfile | Массив с данными о пользователе. |
Коды ответов
Код | Текст | Описание |
---|---|---|
200 | Successful operation | Запрос успешно обработан. Тело ответа будет содержать данные с информацией о пользователях в xml. |
400 | Bad Request | Ошибка в запросе. |
401 | Unauthorized | Ошибка авторизации. |
403 | Permission denied | У пользователя недостаточно прав для выполнения запроса. |
...