...
Запрос: GET /users
| Информация |
|---|
При запросе GET /user/{user_id} статус для уволенных и заблокированных сотрудников одинаковый — 3. Чтобы различать статусы сотрудников, используйте запрос GET /users/v2. Так, в параметре status заблокированные сотрудники будут обозначаться статусом 3, уволенные — 5. |
...
Заголовки и параметры запроса
Заголовок | Описание | ||
|---|---|---|---|
| Authorization (обязательный) | Базовый URL аккаунта, например, https://myaccount.ispringlearn.ru. | ||
| X-Auth-Email (обязательный) | Логин Владельца аккаунта, Администратора, Администратора подразделения, Автора или пользователя с ролью с индивидуальными настройками. | ||
| X-Auth-Password (обязательный) | Пароль Владельца аккаунта, Администратора, Администратора подразделения, Автора или пользователя с ролью с индивидуальными настройками. | ||
| Токен доступа. Вы можете получить токен с помощью запроса | |||
| Параметр | Описание | ||
| departments (необязательный) | Массив ID подразделений, список пользователей которых вы хотите получить | .||
| groups (необязательный) | Массив ID групп, список пользователей которых вы которых вы хотите получить. | ||
| pageSize (необязательный) | Количество записей на 1 страницу. Если не указан, то 1000. | ||
| pageToken (необязательный) | Токен для перехода на следующую страницу. | ||
| logins (необязательный) | Массив логинов пользователей, список которых вы хотите получить | .||
| emails (необязательный) | Массив email-адресов пользователей, список | которых выкоторых вы хотите получить | .|
| status | Статус пользователя. Возможные значения:
| .
Параметры ответа
Параметр | Описание |
|---|---|
| userProfile | Массив с данными о пользователе. |
Коды ответов
Код | Текст | Описание |
|---|---|---|
| 200 | OK | Запрос успешно обработан. Тело Тело ответа будет содержать данные с информацией о пользователях в 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=MmFiZmJhNDItZmE1MS0xMWU5LTk1ZjAtMGE1ODBhZjQwYTgz https/1.1 Host: api-learn.ispringlearn.ru X-Auth-Account-Url: https://myaccount.ispringlearn.ru X-Auth-Email: email@email.com X-Auth-Password: password Authorization: p-1sJDjmULL5DdpXPJTcbm4jVIaWVHvNmrjAxATRbNE |
Пример ответа
| Блок кода | ||
|---|---|---|
| ||
https/1.1 200 OK
<?xml version="1.0" encoding="UTF-8"?>
<response>
<userProfiles>
<userProfile>
...
</userProfile>
<userProfile>
...
</userProfile>
</userProfiles>
<nextPageToken>string</nextPageToken>
</response> |
...