(Новая страница: «Этот вызов API извлекает список пользователей кластера. ==Аутентификация== Для выполнения...») |
Нет описания правки |
||
(не показаны 4 промежуточные версии 3 участников) | |||
Строка 1: | Строка 1: | ||
'''''[[Установка и настройка]] / [[Установка и настройка|Основные элементы АппОптима]] / [[АппОптима]] / [[АппОптима|REST API]] / [[API Кластера v1]] / [[API Кластера v1|Пользователи]] / Получение списка пользователей''''' | |||
Этот вызов API извлекает список пользователей кластера. | Этот вызов API извлекает список пользователей кластера. | ||
==Аутентификация== | ==Аутентификация== | ||
Для выполнения этого запроса вам необходимо разрешение API <code>(ServiceProviderAPI)</code>, назначенное вашему токену API. Создайте свой токен API с помощью консоли управления кластером (CMC). Чтобы узнать, как его получить и использовать, см. | Для выполнения этого запроса вам необходимо разрешение API <code>(ServiceProviderAPI)</code>, назначенное вашему токену API. Создайте свой токен API с помощью консоли управления кластером (CMC). Чтобы узнать, как его получить и использовать, см. Аутентификация кластера. | ||
==Конечная точка== | ==Конечная точка== | ||
<code>/api/v1.0/onpremise/users</code> | <code>/api/v1.0/onpremise/users</code> | ||
Строка 52: | Строка 54: | ||
|} | |} | ||
===JSON-модель тела ответа=== | ===JSON-модель тела ответа=== | ||
< | <[ | ||
{ | { | ||
"id": "string", | "id": "string", | ||
Строка 63: | Строка 65: | ||
] | ] | ||
} | } | ||
] | ] | ||
==Пример== | ==Пример== | ||
В этом примере вы извлекаете всех пользователей кластера. Для каждого пользователя вы получаете подробную информацию и членство в группах. | В этом примере вы извлекаете всех пользователей кластера. Для каждого пользователя вы получаете подробную информацию и членство в группах. | ||
====Curl==== | ====Curl==== | ||
<code>curl -X GET "<nowiki>https:// | <code>curl -X GET "<nowiki>https://myАппОптима.cluster.com/api/v1.0/onpremise/users</nowiki>" -H "accept: application/json"</code> | ||
====URL-адрес запроса==== | ====URL-адрес запроса==== | ||
<code><nowiki>https:// | <code><nowiki>https://myАппОптима.cluster.com/api/v1.0/onpremise/users</nowiki></code> | ||
====Тело ответа==== | ====Тело ответа==== | ||
< | <[ | ||
{ | { | ||
"id": "john.wicked", | "id": "john.wicked", | ||
Строка 91: | Строка 93: | ||
"groups": ["users"] | "groups": ["users"] | ||
} | } | ||
] | ] | ||
====Код ответа==== | ====Код ответа==== | ||
<code>200</code> | <code>200</code> |
Текущая версия от 15:54, 6 января 2025
Установка и настройка / Основные элементы АппОптима / АппОптима / REST API / API Кластера v1 / Пользователи / Получение списка пользователей
Этот вызов API извлекает список пользователей кластера.
Аутентификация
Для выполнения этого запроса вам необходимо разрешение API (ServiceProviderAPI)
, назначенное вашему токену API. Создайте свой токен API с помощью консоли управления кластером (CMC). Чтобы узнать, как его получить и использовать, см. Аутентификация кластера.
Конечная точка
/api/v1.0/onpremise/users
Параметры
Запрос не предоставляет никаких настраиваемых параметров.
Ответ
Коды ответа
Код | Тип | Описание |
---|---|---|
200 | UserConfig[] | Success |
Объекты тела ответа
Объект ResponseBody
Объект не предоставляет никаких параметров.
Объект UserConfig
Конфигурация пользователя.
Элемент | Тип | Описание |
---|---|---|
id | string | ID пользователя |
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