(Новая страница: «Этот вызов API извлекает информацию о конкретном пользователе кластера. ==Аутентификация=...») |
Нет описания правки |
||
| (не показаны 2 промежуточные версии 2 участников) | |||
| Строка 1: | Строка 1: | ||
'''''Установка и настройка / Основные элементы АппОптима / АппОптима / REST API / 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> | ||
| Строка 71: | Строка 73: | ||
|} | |} | ||
===JSON-модель тела ответа=== | ===JSON-модель тела ответа=== | ||
< | <{ | ||
"id": "string", | "id": "string", | ||
"email": "string", | "email": "string", | ||
| Строка 80: | Строка 82: | ||
"string" | "string" | ||
] | ] | ||
} | } | ||
==Пример== | ==Пример== | ||
В этом примере вы получаете информацию о пользователе <code>john.wicked</code>. | В этом примере вы получаете информацию о пользователе <code>john.wicked</code>. | ||
====Curl==== | ====Curl==== | ||
<code>curl -X GET "<nowiki>https:// | <code>curl -X GET "<nowiki>https://myАппОптима.cluster.com/api/v1.0/onpremise/users/john.wicked</nowiki>" -H "accept: application/json"</code> | ||
====URL-адрес запроса==== | ====URL-адрес запроса==== | ||
<code><nowiki>https:// | <code><nowiki>https://myАппОптима.cluster.com/api/v1.0/onpremise/users/john.wicked</nowiki></code> | ||
====Тело ответа==== | ====Тело ответа==== | ||
< | <{ | ||
"id": "john.wicked", | "id": "john.wicked", | ||
"email": "john.wicked@company.com", | "email": "john.wicked@company.com", | ||
| Строка 97: | Строка 99: | ||
"admin" | "admin" | ||
] | ] | ||
} | } | ||
====Код ответа==== | ====Код ответа==== | ||
<code>200</code> | <code>200</code> | ||
Текущая версия от 16:13, 25 декабря 2024
Установка и настройка / Основные элементы АппОптима / АппОптима / REST API / API Кластера v1 / Пользователи / Получение информации о пользователе
Этот вызов API извлекает информацию о конкретном пользователе кластера.
Аутентификация
Для выполнения этого запроса вам необходимо разрешение API (ServiceProviderAPI), назначенное вашему токену API. Создайте свой токен API с помощью консоли управления кластером (CMC). Чтобы узнать, как его получить и использовать, см. Аутентификация кластера.
Конечная точка
/api/v1.0/onpremise/users
Параметры
| Параметр | Тип | Описание | В | Обязательно |
|---|---|---|---|---|
| id | string | Параметр пути идентификатора пользователя. Отсутствующие или пустые значения вернут «Bad Request». | path | Да |
Ответ
Коды ответа
| Код | Тип | Описание |
|---|---|---|
| 200 | UserConfig[] | Успех |
| 400 | Информация об идентификаторе не получена для запроса на получение пользователя | |
| 404 | Не найдено |
Объекты тела ответа
Объект 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"
]
}
Пример
В этом примере вы получаете информацию о пользователе john.wicked.
Curl
curl -X GET "https://myАппОптима.cluster.com/api/v1.0/onpremise/users/john.wicked" -H "accept: application/json"
URL-адрес запроса
https://myАппОптима.cluster.com/api/v1.0/onpremise/users/john.wicked
Тело ответа
<{
"id": "john.wicked",
"email": "john.wicked@company.com",
"firstName": "John",
"lastName": "Wicked",
"passwordClearText": null,
"groups": [
"admin"
]
}
Код ответа
200