Запрос: GET /users
Права пользователя для выполнения запроса
Владелец аккаунта, Администратор аккаунта, Администратор подразделения, Автор или роль с индивидуальными настройками.
Администратор подразделения, Автор и пользователь с ролью с индивидуальными настройками могут получать список пользователей только тех подразделений, которыми управляют, и вложенных в них подразделений.
Заголовки и параметры запроса
Заголовок | Описание |
|---|---|
| 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 | У пользователя недостаточно прав для выполнения запроса. |
Пример запроса
GET/users?departments[]=f0050578-c3dd-11e9-9d5d-4a54cfb3a702&groups[]=2aa6c5d2-fa51-11e9-b3bf-0a580af40a83&pageSize=1&pageToken=MmFiZmJhNDItZmE1MS0xMWU5LTk1ZjAtMGE1ODBhZjQwYTgzHTTP/1.1 Host: api-learn.ispringlearn.ru X-Auth-Account-Url: http://myaccount.ispringlearn.ru X-Auth-Email: email@email.com X-Auth-Password: password
Пример ответа
HTTP/1.1 200 Successful operation
Connection: close
<?xml version="1.0" encoding="UTF-8"?>
<response>
<userProfiles>
<userProfile>
...
</userProfile>
<userProfile>
...
</userProfile>
</userProfiles>
<nextPageToken>string</nextPageToken>
</response>
Рекомендованные статьи
<