iSpring Port

Дерево страниц

Метод: listUsers

При запросе listUsers вы получите одинаковый статус для уволенных и заблокированных — 3. Чтобы различать статусы, используйте запрос listUsersV2. Так, в параметре status заблокированные сотрудники будут обозначаться статусом 3, уволенные — 5.

Если в вашем аккаунте СДО более 1000 пользователей, используйте запрос Получение постраничного списка пользователей.

Параметры запроса

ПараметрТипОписание
token (обязательный)stringТокен доступа. Вы можете получить токен с помощью запроса
groupId (необязательный)stringЕсли этот параметр указан, будут выбраны пользователи, которые относятся к указанной группе
departmentId (необязательный)stringЕсли этот параметр указан, будут выбраны пользователи указанного подразделения
pageSize (необязательный)stringКоличество записей на 1 страницу. Если не указан, то 1000
pageToken (необязательный)stringТокен для перехода на следующую страницу
logins (необязательный)stringМассив логинов пользователей, список которых вы хотите получить
emails (необязательный)stringМассив email-адресов пользователей, список которых вы хотите получить

Права пользователя для выполнения запроса 

Владелец аккаунта, Администратор аккаунта, Администратор подразделения, Автор или роль с индивидуальными настройками.

Администратор подразделения, Автор или пользователь с ролью с индивидуальными настройками могут получить список пользователей только своего подразделения и вложенных в него подразделений.

Возвращаемые значения

После того, как запрос успешно обработан, система возвращает объект со следующими свойствами:

ПараметрТипОписание
usersUserProfile[]Массив с профилями пользователей. Объект UserProfile имеет такие же свойства, как метод getUserProfile
nextPageTokenstringТокен для перехода на следующую страницу

Возможные ошибки

ОшибкаОписание
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:token>p-1sJDjmULL5DdpXPJTcbm4jVIaWVHvNmrjAxATRbNE</soap:token>
         </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>