ДОСТУПНО В BUSINESS ПОДПИСКЕ
Запрос: GET /user/{user_id}
При запросе GET /user/{user_id} статус для уволенных и заблокированных сотрудников одинаковый — 3.
Чтобы различать статусы сотрудников, используйте запрос GET /user/{user_id}/v2. Так, в параметре status заблокированные сотрудники будут обозначаться статусом 3, уволенные — 5.
Права для выполнения запроса
Владелец аккаунта, Администратор аккаунта, Администратор подразделения, Автор или роль с индивидуальными настройками.
Администратор подразделения, Автор и пользователь с ролью с индивидуальными настройками могут получать информацию только о пользователях подразделений, которыми управляют, и вложенных в них подразделений.
Заголовки и параметры запроса
Заголовок | Описание |
---|---|
Authorization (обязательный) | Токен доступа. Вы можете получить токен с помощью запроса |
Параметр | Описание |
user_id (обязательный) | ID пользователя, информацию о котором вы хотите получить |
Параметры ответа
Параметр | Описание | |
---|---|---|
userProfile | Массив с данными о пользователе | |
userId | ID пользователя | |
role | Роль пользователя.
Подробнее о способах назначения ролей пользователям читайте в статье Добавление пользователя | |
departmentId | ID подразделения, в котором состоит пользователь. | |
status | Статус пользователя. Возможные значения:
| |
fields | Массив с данными о полях профиля пользователя. В него включены названия полей профиля и их значения | |
groups | Массив с ID групп, в которых состоит пользователь | |
manageableDepartmentIds | ID подразделений, которыми управляет пользователь, если его роль Администратор подразделения, Автор или роль с индивидуальными настройками | |
userRoles | Массив с данными о ролях пользователя. Подробнее о способах назначения ролей пользователям читайте в статье Добавление пользователя | |
addedDate | Дата добавления пользователя | |
lastLoginDate | Дата последнего входа в аккаунт | |
subordination (необязательный) | Объект с данными о типе подчинения линейного руководителя | |
coSubordination (необязательный) | Объект с данными о типе подчинения функционального руководителя | |
subordinationType (обязательный) | Тип подчинения линейного и функционального руководителя. Возможные значения:
| |
workLeaveStatus (необязательный) | Рабочий статус отсутствия. Массив с параметрами:
| |
supervisorId (необязательный) | ID руководителя | Указываете, если subordinationType = manual |
- | Если subordinationType = inherit, no_supervisor, указывать не нужно |
Коды ответов
Код | Текст | Описание |
---|---|---|
200 | OK | Запрос успешно обработан |
400 | Bad Request | Ошибка в запросе |
401 | Unauthorized | Ошибка авторизации |
403 | Permission denied | У пользователя недостаточно прав для выполнения запроса |
Пример запроса
GET /user/f29d887c-5cff-11e9-9e6a-0a580af40692 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>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>Kate</value> </field> <field> <name>LAST_NAME</name> <value>Smith</value> </field> <field> <name>LOGIN</name> <value>kate.smith</value> </field> <field> <name>EMAIL</name> <value>kate.smith@test.com</value> </field> <field> <name>PHONE</name> <value></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>