iSpring Port

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

Метод: getUsers

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

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

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

ПараметрТипОписание
token (обязательный)stringТокен доступа. Вы можете получить токен с помощью запроса
groupId (необязательный)stringЕсли этот параметр указан, будут выбраны пользователи, которые относятся к указанной группе
departmentId (необязательный)stringЕсли этот параметр указан, будут выбраны пользователи указанного подразделения

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

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

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

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

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

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

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

ОшибкаОписание
Permission denied

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

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

Пример запроса

<?xml version="1.0" encoding="utf-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="https://schemas.xmlsoap.org/soap/envelope/"
                   xmlns="https://ispringlearn.com/go/services/api/soap">
  <SOAP-ENV:Body>
    <GetUsersRequest>
      <credentials>
        <token>p-1sJDjmULL5DdpXPJTcbm4jVIaWVHvNmrjAxATRbNE</token>
      </credentials>
    </GetUsersRequest>
    <groupId>string</groupId>
    <departmentId>string</departmentId>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Пример ответа

<?xml version="1.0" encoding="utf-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="https://schemas.xmlsoap.org/soap/envelope/"
                   xmlns="https://ispringlearn.com/go/services/api/soap">
  <SOAP-ENV:Body>
    <GetUsersResult>
      <userProfile>
	    <userId>43eb7146-6280-11e9-b274-a6210366ac32</userId>
		<role>publisher</role>
		<departmentId>e95b4ad0-5f50-11e9-80c4-0a580af406eb</departmentId>
		<status>1</status>
		<fields>
          <field>
            <name>LOGIN</name>
            <value>elena@ispring.ru</value>
          </field>
          <field>
            <name>EMAIL</name>
            <value>elena@ispring.ru</value>
          </field>
          <field>
            <name>FIRST_NAME</name>
            <value>Елена</value>
          </field>
          <field>
             <name>LAST_NAME</name>
             <value>Смирнова</value>
          </field>
          <field>
             <name>JOB_TITLE</name>
             <value>Бухгалтер</value>
          </field>
          <field>
             <name>COUNTRY</name>
             <value>643</value>
          </field>
        </fields>
		<groups>
			<id>e0b394fc-44b9-11e9-92c8-0a580af401f6</id>
		</groups>
		<manageableDepartmentIds>
			<id>3fa85f64-5717-4562-b3fc-2c963f66afa6</id>
		</manageableDepartmentIds>
        <userRoles>
          <userRole>
            <roleId>eaf01e14-2ae1-11e9-89a5-0242ac13000a</roleId>
            <roleType>department_administrator</roleType>
            <manageableDepartmentIds>
              <id>f9de0c52-6f59-11ea-b88f-cee299842653</id>
              <id>f9d9f306-6f59-11ea-ad9a-cee299842653</id>
            </manageableDepartmentIds>
          </userRole>
        </userRoles>
		<addedDate>2019-04-30</addedDate>
		<lastLoginDate>2019-04-30</lastLoginDate>
	</userProfile>
    <userProfile>
		<userId>43eb7146-6280-11e9-b274-a6210366ac33</userId>
		<role>string</role>
		<departmentId>e95b4ad0-5f50-11e9-80c4-0a580af406eb</departmentId>
		<status>1</status>
		<fields>
          <field>
            <name>LOGIN</name>
            <value>denis@ispring.ru</value>
          </field>
          <field>
            <name>EMAIL</name>
            <value>denis@ispring.ru</value>
          </field>
          <field>
            <name>FIRST_NAME</name>
            <value>Денис</value>
          </field>
          <field>
            <name>LAST_NAME</name>
            <value>Петров</value>
          </field>
          <field>
            <name>JOB_TITLE</name>
            <value>Менеджер</value>
          </field>
          <field>
            <name>COUNTRY</name>
            <value>643</value>
          </field>
        </fields>
		<groups>
		  <id>e0b394fc-44b9-11e9-92c8-0a580af401f6</id>
		</groups>
		<manageableDepartmentIds>
		  <id>3fa85f64-5717-4562-b3fc-2c963f66afa6</id>
		</manageableDepartmentIds>
        <userRoles>
          <userRole>
            <roleId>eaf01e14-2ae1-11e9-89a5-0242ac13111b</roleId>
            <roleType>publisher</roleType>
            <manageableDepartmentIds>
              <id>f9de0c52-6f59-11ea-b88f-cee299842653</id>
              <id>f9d9f306-6f59-11ea-ad9a-cee299842653</id>
            </manageableDepartmentIds>
          </userRole>
        </userRoles>
		<addedDate>2019-04-29</addedDate>
		<lastLoginDate>2019-04-30</lastLoginDate>
      </userProfile>
    </GetUsersResult>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>