Запрос: GET /user

При запросе GET /user/{user_id} статус для уволенных и заблокированных сотрудников одинаковый — 3.

Чтобы различать статусы сотрудников, используйте запрос GET /user/v2. Так, в параметре status заблокированные сотрудники будут обозначаться статусом 3, уволенные — 5.

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

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

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

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

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

Заголовок	Описание
Authorization (обязательный)	Токен доступа. Вы можете получить токен с помощью запроса
Параметр	Описание
departments (необязательный)	Массив ID подразделений, список пользователей которых вы хотите получить
groups (необязательный)	Массив ID групп, список пользователей которых вы хотите получить

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

Параметр	Описание
userProfile	Массив с данными о пользователе
userId	ID пользователя
role	Роль пользователя. Возможные значения: learner — Обучающийся, administrator — Администратор аккаунта, department_administrator — Администратор подразделения, custom — Автор или роль с индивидуальными настройками. Подробнее о способах назначения ролей пользователям читайте в статье Добавление пользователя
departmentId	ID подразделения, в котором состоит пользователь
status	Статус пользователя. Возможные значения: 1 — активный, 3 — заблокированный, 5 — уволенный
fields	Массив с данными о полях профиля пользователя. В него включены названия полей профиля и их значения
groups	Массив с ID групп, в которых состоит пользователь
manageableDepartmentIds	ID подразделений, которыми управляет пользователь, если его роль Администратор подразделения, Автор или роль с индивидуальными настройками
userRoles	Массив с данными о ролях пользователя. Подробнее о способах назначения ролей пользователям читайте в статье Добавление пользователя
addedDate	Дата добавления пользователя
lastLoginDate	Дата последнего входа в аккаунт

Коды ответов

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

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

GET /user?departments[]=e95b4ad0-5f50-11e9-80c4-0a580af406eb&groups[]=e0b394fc-44b9-11e9-92c8-0a580af401f6 https/1.1
Host: api-learn.ispringlearn.ru 
Authorization: p-1sJDjmULL5DdpXPJTcbm4jVIaWVHvNmrjAxATRbNE

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

https/1.1 200 OK

<?xml version="1.0" encoding="UTF-8"?>
<response>
    <userProfile>
        <role>owner</role>
        <roleId>eaefe76e-2ae1-11e9-b90a-0242ac13000a</roleId>
        <userId>114dba08-a75e-11eb-b4e5-0242ac13002a</userId>
        <departmentId>1141d74c-a75e-11eb-ad56-0242ac13002a</departmentId>
        <status>1</status>
        <fields>
            <field>
                <name>FIRST_NAME</name>
                <value>Account</value>
            </field>
            <field>
                <name>LAST_NAME</name>
                <value>Owner</value>
            </field>
            <field>
                <name>LOGIN</name>
                <value>owner</value>
            </field>
            <field>
                <name>EMAIL</name>
                <value>owner@test.com</value>
            </field>
            <field>
                <name>PHONE</name>
                <value></value>
            </field>
            <field>
                <name>JOB_TITLE</name>
                <value></value>
            </field>
            <field>
                <name>COUNTRY</name>
                <value></value>
            </field>
        </fields>
        <addedDate>2021-04-27</addedDate>
        <lastLoginDate>2021-09-14</lastLoginDate>
        <manageableDepartmentIds>
            <id>1141d74c-a75e-11eb-ad56-0242ac13002a</id>
        </manageableDepartmentIds>
        <userRoles>
            <userRole>
                <roleId>eaefe76e-2ae1-11e9-b90a-0242ac13000a</roleId>
                <roleType>owner</roleType>
                <manageableDepartmentIds>
                    <id>1141d74c-a75e-11eb-ad56-0242ac13002a</id>
                </manageableDepartmentIds>
            </userRole>
            <userRole>
                <roleId>ab513fba-fc2e-11eb-a2f0-0242ac130034</roleId>
                <roleType>custom</roleType>
                <manageableDepartmentIds>
                    <id>1141d74c-a75e-11eb-ad56-0242ac13002a</id>
                </manageableDepartmentIds>
            </userRole>
        </userRoles>
    </userProfile>
    <userProfile>
        <role>department_administrator</role>
        <roleId>eaf01e14-2ae1-11e9-89a5-0242ac13000a</roleId>
        <userId>3d7e1028-1545-11ec-b8d1-0242ac17002a</userId>
        <departmentId>1141d74c-a75e-11eb-ad56-0242ac13002a</departmentId>
        <status>1</status>
        <fields>
            <field>
                <name>FIRST_NAME</name>
                <value>Денис</value>
            </field>
            <field>
                <name>LAST_NAME</name>
                <value>Макеев</value>
            </field>
            <field>
                <name>LOGIN</name>
                <value>denis.makeev</value>
            </field>
            <field>
                <name>EMAIL</name>
                <value>denis.makeev@ispring.ru</value>
            </field>
            <field>
                <name>PHONE</name>
                <value>+89078887632</value>
            </field>
            <field>
                <name>JOB_TITLE</name>
                <value>Sales Manager</value>
            </field>
            <field>
                <name>COUNTRY</name>
                <value></value>
            </field>
        </fields>
        <addedDate>2021-09-14</addedDate>
        <groups>
            <id>14b5893c-a75e-11eb-a87c-0242ac13002a</id>
            <id>ee5a6cca-154a-11ec-a6a8-0242ac17002a</id>
        </groups>
        <manageableDepartmentIds>
            <id>1141d74c-a75e-11eb-ad56-0242ac13002a</id>
        </manageableDepartmentIds>
        <userRoles>
            <userRole>
                <roleId>eaf01e14-2ae1-11e9-89a5-0242ac13000a</roleId>
                <roleType>department_administrator</roleType>
                <manageableDepartmentIds>
                    <id>1141d74c-a75e-11eb-ad56-0242ac13002a</id>
                </manageableDepartmentIds>
            </userRole>
        </userRoles>
    </userProfile>
</response>

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

Получение списка пользователей