Перейти к содержанию

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

Возвращает список пользователей, соответствующих критериям поиска. По умолчанию возвращается список пользователей, имеющих системные роли.

GET /cwm/public/api/v1/users

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

displayName

Отображаемое имя пользователя (вхождение подстроки)
?displayName=ivan

email

Адрес почты пользователя (вхождение подстроки)
?email=ivan.ivanov@teamstorm.ru

username

Логин пользователя (вхождение подстроки)
?username=ivan.ivanov

providerId

Идентификатор провайдера аутентификации ?providerId=3fa85f64-5717-4562-b3fc-2c963f66afa6

Возможно комбинирование параметров.

Тело успешного ответа 200

200
{
  "items": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "displayName": "string",
      "username": "string",
      "email": "string",
      "providerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    }
  ]
}

Описание возвращаемой модели

items

Список пользователей.
Описание модели пользователя см. в подразделе Получение пользователя

Ошибки

400 (Bad Request)

Неправильный (несуществующий) параметр запроса

401 (Unauthorized)

Неавторизованный запрос

403 (Forbidden)

Отказ доступа к объекту

404 (Not Found)

Несуществующее расположение

500 (Server Error)

Внутренняя ошибка сервиса