Документация по iSpring Learn

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

Сравнение версий

Старая версия 15

changes.mady.by.user admin

Сохранено

по сравнению с

Новая версия Текущий

changes.mady.by.user Алина Задина

Сохранено

Ключ

  • Эта строка добавлена.
  • Эта строка удалена.
  • Изменено форматирование.

Включить страницу
Лэйблы с указанием тарифа
Лэйблы с указанием тарифа

Запрос: GET GET /users

Оглавление
minLevel2

Заголовки

Информация

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

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

Оглавление
minLevel2

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

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

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

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

Заголовок

Описание

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

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

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

Заголовок

Описание

Authorization (обязательный)

Токен доступа. Вы можете получить токен с помощью запроса

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

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

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

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

...

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

  • 1 — активный,
  • 3 — заблокированный,
  • 5 — уволенный
workLeaveStatus (необязательный)

Рабочий статус отсутствия. Массив с параметрами:

  • workLeaveReason — причины отсутствия,
  • startDate — дата начала отсутствия. Указывается в формате yyyy-mm-dd,
  • endDate — дата завершения отсутствия. Указывается в формате yyyy-mm-dd,

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

Параметр

Описание

userProfileМассив с данными о пользователе

Коды ответов

Код

Текст

Описание

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

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

Блок кода
languagexml
GET/users?departments[]=f0050578-c3dd-11e9-9d5d-4a54cfb3a702&groups[]=2aa6c5d2-fa51-11e9-b3bf-0a580af40a83&pageSize=1&pageToken=MmFiZmJhNDItZmE1MS0xMWU5LTk1ZjAtMGE1ODBhZjQwYTgzHTTPMmFiZmJhNDItZmE1MS0xMWU5LTk1ZjAtMGE1ODBhZjQwYTgz https/1.1
Host: api-learn.ispringlearn.ru
X-Auth-Account-Url: http://myaccount.ispringlearn.ru
X-Auth-Email: email@email.com
X-Auth-Password: password
Authorization: p-1sJDjmULL5DdpXPJTcbm4jVIaWVHvNmrjAxATRbNE

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

Блок кода
languagexml
HTTPhttps/1.1 200 Successful operation
Connection: closeOK

<?xml version="1.0" encoding="UTF-8"?>
<response>
    <userProfiles>
        <userProfile>
            ...
        </userProfile>
        <userProfile>
            ...
        </userProfile>
    </userProfiles>
    <nextPageToken>string</nextPageToken>
</response>

...