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

2022-09-16T17:06:28Z

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

← Предыдущая	Версия 17:06, 16 сентября 2022
(нет различий)

RGolovanov: Новая страница: «Этот вызов API извлекает список пользователей кластера. ==Аутентификация== Для выполнения...»

2022-09-16T17:05:11Z

Новая страница: «Этот вызов API извлекает список пользователей кластера. ==Аутентификация== Для выполнения...»

Новая страница

Этот вызов API извлекает список пользователей кластера.
==Аутентификация==
Для выполнения этого запроса вам необходимо разрешение API <code>(ServiceProviderAPI)</code>, назначенное вашему токену API. Создайте свой токен API с помощью консоли управления кластером (CMC). Чтобы узнать, как его получить и использовать, см. [https://doc.ruscomtech.ru/index.php/%D0%90%D1%83%D1%82%D0%B5%D0%BD%D1%82%D0%B8%D1%84%D0%B8%D0%BA%D0%B0%D1%86%D0%B8%D1%8F_%D0%BA%D0%BB%D0%B0%D1%81%D1%82%D0%B5%D1%80%D0%B0 Аутентификация кластера].
==Конечная точка==
<code>/api/v1.0/onpremise/users</code>
==Параметры==
Запрос не предоставляет никаких настраиваемых параметров.
==Ответ==
===Коды ответа===
{| class="wikitable"
!Код
|'''Тип'''
!Описание
|-
|'''200'''
|UserConfig[]
|Success
|}
===Объекты тела ответа===
====Объект <code>ResponseBody</code>====
Объект не предоставляет никаких параметров.
====Объект <code>UserConfig</code>====
Конфигурация пользователя.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|id
|string
|ID пользователя
|-
|email
|string
|Адрес электронной почты пользователя
|-
|firstName
|string
|Имя пользователя
|-
|lastName
|string
|Фамилия пользователя
|-
|passwordClearText
|string
|Пароль пользователя открытым текстом; используется только для установки начального пароля
|-
|groups
|string[]
|Список идентификаторов групп пользователей пользователя.
|}
===JSON-модель тела ответа===
<code>[
{
"id": "string",
"email": "string",
"firstName": "string",
"lastName": "string",
"passwordClearText": "string",
"groups": [
"string"
]
}
]</code>
==Пример==
В этом примере вы извлекаете всех пользователей кластера. Для каждого пользователя вы получаете подробную информацию и членство в группах.
====Curl====
<code>curl -X GET "<nowiki>https://myManaged.cluster.com/api/v1.0/onpremise/users</nowiki>" -H "accept: application/json"</code>
====URL-адрес запроса====
<code><nowiki>https://myManaged.cluster.com/api/v1.0/onpremise/users</nowiki></code>
====Тело ответа====
<code>[
{
"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"]
}
]</code>
====Код ответа====
<code>200</code>

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

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

RGolovanov: Новая страница: «Этот вызов API извлекает список пользователей кластера. ==Аутентификация== Для выполнения...»