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

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

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

GET /cwm/public/api/v1/workspaces/{workspace}/users

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

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

Ключ или идентификатор пространства
/cwm/public/api/v1/workspaces/KEY/users
/cwm/public/api/v1/workspaces/f5ce1753-ced5-4992-beb9-7408c1a56cf8/users

displayName

Отображаемое имя пользователя для поиска
?displayName=ivanov

roleId

Идентификатор роли пользователя для поиска
?roleId=f5ce1753-ced5-4992-beb9-7408c1a56cf8

fromToken

Токен запрашиваемой страницы
?fromToken=f5ce1753

maxItemsCount

Максимальное кол-во задач на странице (по умолчанию: 50)
?maxItemsCount=200

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

{
  "fromToken": "string",
  "maxItemsCount": 0,
  "nextToken": "string",
  "items": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "displayName": "string",
      "username": "string",
      "email": "string"
    }
  ]
}

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

fromToken

Токен текущей страницы результатов

maxItemsCount

Кол-во запрошенных элементов на странице результатов

nextToken

Токен следующей страницы результатов

items

Список пользователей. Модель пользователя описана в таблице Описание возвращаемой модели пользователя.