Page tree
Skip to end of metadata
Go to start of metadata

Запрос: GET /user

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

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

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

Заголовки и параметры запроса

Заголовок

Описание

X-Auth-Account-Url (обязательный)

Базовый URL аккаунта, например, https://myaccount.ispringlearn,ru.

X-Auth-Email (обязательный)Логин Владельца аккаунтаАдминистратора, Администратора подразделения, Автора или пользователя с ролью с индивидуальными настройками.
X-Auth-Password (обязательный)Пароль Владельца аккаунтаАдминистратора, Администратора подразделения, Автора или пользователя с ролью с индивидуальными настройками.
ПараметрОписание
departments (необязательный)Массив ID подразделений, список пользователей которых вы хотите получить. 
groups (необязательный)Массив ID групп, список пользователей которых вы хотите получить.

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

ПараметрОписание
userProfileМассив с данными о пользователе.
userId

ID пользователя.

role

Роль пользователя. 

Возможные значения:

Подробнее о способах назначения ролей пользователям читайте в статье Добавление пользователя

departmentIdID подразделения, в котором состоит пользователь.
status

Статус пользователя. 

Возможные значения:

  • 1 — активный
  • 3 — заблокированный
fields

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

groupsМассив с ID групп, в которых состоит пользователь.
manageableDepartmentIdsID подразделений, которыми управляет пользователь, если его роль Администратор подразделения, Автор или роль с индивидуальными настройками
userRoles

Массив с данными о ролях пользователя.

Подробнее о способах назначения ролей пользователям читайте в статье Добавление пользователя

addedDateДата добавления пользователя.
lastLoginDateДата последнего входа в аккаунт.

Коды ответов

Код

Текст

Описание

200Successful operationЗапрос успешно обработан. Тело ответа будет содержать данные с информацией о пользователях в xml.
400Bad RequestОшибка в запросе.
401UnauthorizedОшибка авторизации.
403Permission deniedУ пользователя недостаточно прав для выполнения запроса.

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

GET /user?departments[]=e95b4ad0-5f50-11e9-80c4-0a580af406eb&groups[]=e0b394fc-44b9-11e9-92c8-0a580af401f6 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

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

https/1.1 200 Successful operation
Connection: close

<?xml version="1.0" encoding="UTF-8"?>
<response>
	<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>publisher</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>department_administrator</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>department_administrator</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>
</response>