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

Установка и настройка / Основные элементы АппОптима / АппОптима / REST API / API Кластера v1 / Пользователи / Получение списка пользователей

Этот вызов API извлекает список пользователей кластера.

Аутентификация

Для выполнения этого запроса вам необходимо разрешение API (ServiceProviderAPI), назначенное вашему токену API. Создайте свой токен API с помощью консоли управления кластером (CMC). Чтобы узнать, как его получить и использовать, см. Аутентификация кластера.

Конечная точка

/api/v1.0/onpremise/users

Параметры

Запрос не предоставляет никаких настраиваемых параметров.

Ответ

Коды ответа

Код	Тип	Описание
200	UserConfig[]	Success

Объекты тела ответа

Объект ResponseBody

Объект не предоставляет никаких параметров.

Объект UserConfig

Конфигурация пользователя.

Элемент	Тип	Описание
id	string	ID пользователя
email	string	Адрес электронной почты пользователя
firstName	string	Имя пользователя
lastName	string	Фамилия пользователя
passwordClearText	string	Пароль пользователя открытым текстом; используется только для установки начального пароля
groups	string[]	Список идентификаторов групп пользователей пользователя.

JSON-модель тела ответа

<[
  {
    "id": "string",
    "email": "string",
    "firstName": "string",
    "lastName": "string",
    "passwordClearText": "string",
    "groups": [
      "string"
    ]
  }
]

Пример

В этом примере вы извлекаете всех пользователей кластера. Для каждого пользователя вы получаете подробную информацию и членство в группах.

Curl

curl -X GET "https://myАппОптима.cluster.com/api/v1.0/onpremise/users" -H  "accept: application/json"

URL-адрес запроса

https://myАппОптима.cluster.com/api/v1.0/onpremise/users

Тело ответа

<[
  {
    "id": "john.wicked",
    "email": "john.wicked@company.com",
    "firstName": "John",
    "lastName": "Wicked",
    "passwordClearText": null,
    "groups": [
      "owners",
      "users"
    ]
  },
  {
    "id": "anne.brown",
    "email": "anne.brown@company.com",
    "firstName": "Anne",
    "lastName": "Brown",
    "passwordClearText": null,
    "groups": ["users"]
  }
]

Код ответа

200