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

Вы просматриваете старую версию данной страницы. Смотрите текущую версию.

Сравнить с текущим просмотр истории страницы

« Предыдущий Версия 4 Следующий »

Запрос

GET /users

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

Параметр

Описание

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

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

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

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

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

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

После того как запрос был успешно обработан, отправляется код ответа 200. Тело ответа будет содержать данные с информацией о пользователях в xml.

Коды ответов

Код

Текст

Описание

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

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

GET/users?departments[]=f0050578-c3dd-11e9-9d5d-4a54cfb3a702&groups[]=2aa6c5d2-fa51-11e9-b3bf-0a580af40a83&pageSize=1&pageToken=MmFiZmJhNDItZmE1MS0xMWU5LTk1ZjAtMGE1ODBhZjQwYTgzHTTP/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

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

HTTP/1.1 200 Successful operation
Connection: close

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


Рекомендованные статьи

<
  • Нет меток