Включить страницу |
---|
| Лэйблы с указанием тарифа |
---|
| Лэйблы с указанием тарифа |
---|
|
Метод: listUsers
Параметры запроса
Параметр | Тип | Описание |
---|
credentials (обязательный) | credentials | Смотрите описание объекта 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:accountUrl>
<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> |
Пример ответа
Блок кода |
---|
|
<?xml version="1.0" encoding="utf-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="https://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://ispringlearn.com/go/services/api/soap">
<SOAP-ENV:Body>
<ns1:ListUsersResult>
<ns1:userProfiles>
<ns1:userProfile>
<ns1:userId>string</ns1:userId>
...
</ns1:userProfile>
<ns1:userProfile>
<ns1:userId>string</ns1:userId>
...
</ns1:userProfile>
<ns1:userProfile>
<ns1:userId>string</ns1:userId>
...
</ns1:userProfile>
</ns1:userProfiles>
<ns1:nextPageToken>string</ns1:nextPageToken>
</ns1:ListUsersResult>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope> |