Запрос

POST /pub/v1/user/list

Тело запроса (body)

Тело запроса принимает ресурс  Получение списка пользователей - Request. Содержит следующие доступные для записи свойства:

{
    "filter": {
        "<key>": {}
    },
    "from": "int64",
    "ids": [
        "string"
    ],
    "size": "int64",
    "sortExpressions": [
        {
            "ascending": "boolean",
            "field": "string"
        }
    ]
}

Свойства

Имя Тип Описание Дополнительно
filter object

Фильтрация

Опционально.
filter.<key> map of object Опционально.
from int64

Начальный индекс (offset) возвращаемых элементов.

Опционально.
ids[] array of string

Фильтрация по идентификаторам

Опционально.
size int64

Количество возвращаемых элементов (максимум 100)

Опционально.
sortExpressions[] array

Правила сортировки

Опционально.
sortExpressions[].ascending boolean

Признак сортировки по возрастанию

Опционально.
sortExpressions[].field string

Поле сортировки

Опционально.

Авторизация

Запрос обязательно должен использовать один из следующих методов авторизации: API key

Ответ

Могут быть возвращены следующие коды состояния HTTP.

HTTP статус Описание Модель ответа
200 OK

Модель списка пользователей.

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