...
| Информация |
|---|
При запросе listUsers вы получите одинаковый статус для уволенных и заблокированных — 3. Чтобы различать статусы, используйте запрос listUsersV2. Так, в параметре status заблокированные сотрудники будут обозначаться статусом 3, уволенные — 5. Если в вашем аккаунте СДО более 1000 пользователей, используйте запрос Получение постраничного списка пользователей. |
Параметры запроса
| Параметр | Тип | Описание | |
|---|---|---|---|
| credentialstoken (обязательный) | credentials | string | Токен доступа. Вы можете получить токен с помощью запросаСмотрите описание объекта Credentials. |
| groupId (необязательный) | string | Если этот параметр указан, будут выбраны пользователи, которые относятся к указанной группе. | |
| departmentId (необязательный) | string | Если этот параметр указан, будут выбраны пользователи указанного подразделения. | |
| pageSize (необязательный) | string | Количество записей на 1 страницу. Если не указан, то 1000. | |
| pageToken (необязательный) | string | Токен для перехода на следующую страницу. | |
| logins (необязательный) | string | Массив логинов пользователей, список которых вы хотите получить. | |
| emails (необязательный) | string | Массив email-адресов пользователей, список которых вы которых вы хотите получить. |
Права пользователя для выполнения запроса
Владелец аккаунта, Администратор аккаунта, Администратор подразделения, Автор или роль с индивидуальными настройками.
Администратор подразделения, Автор или пользователь с ролью с индивидуальными настройками могут получить список пользователей только своего подразделения и вложенных в него подразделений.
...
| Параметр | Тип | Описание |
|---|---|---|
| users | UserProfile[] | Массив с профилями пользователей. Объект UserProfile имеет такие же свойства, как метод getUserProfile. |
| nextPageToken | string | Токен для перехода на следующую страницу. |
Возможные ошибки
| Ошибка | Описание |
|---|---|
| Permission denied | У пользователя недостаточно прав для выполнения запроса. Например, администратор подразделения не может получить список пользователей подразделения, которым не управляет. |
Пример запроса
| Блок кода | ||
|---|---|---|
| ||
<?xml version="1.0" encoding="utf-8"?>
<soapenv:Envelope xmlns:soapenv="https://schemas.xmlsoap.org/soap/envelope/" xmlns:soap="https://ispringlearn.com/go/services/api/soap">
<soapenv:Header/>
<soapenv:Body>
<soap:ListUsersRequest>
<soap:credentials>
<soap:accountUrl>https://myaccount.ispringlearn.ru<<soap:token>p-1sJDjmULL5DdpXPJTcbm4jVIaWVHvNmrjAxATRbNE</soap:accountUrl>token>
<soap:email>email@email.com</soap:email>
<soap:password>password</soap:password>
< </soap:credentials>
<soap:groupIds>
<soap:id>string</soap:id>
</soap:groupIds>
<soap:departmentIds>
<soap:id>string</soap:id>
</soap:departmentIds>
<soap:pageToken>string</soap:pageToken>
<soap:pageSize>1000</soap:pageSize>
</soap:ListUsersRequest>
</soapenv:Body>
</soapenv:Envelope> |
...