ENetrebin (обсуждение | вклад) Нет описания правки |
Нет описания правки |
||
| Строка 1: | Строка 1: | ||
''''' | '''''Установка и настройка / Основные элементы АппОптима / АппОптима Managed / 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> | ||
| Строка 64: | Строка 64: | ||
=== JSON-модель тела запроса === | === JSON-модель тела запроса === | ||
Это модель тела запроса, показывающая возможные элементы. Его необходимо настроить для использования в реальном запросе. | Это модель тела запроса, показывающая возможные элементы. Его необходимо настроить для использования в реальном запросе. | ||
< | <{ | ||
"id": "string", | "id": "string", | ||
"email": "string", | "email": "string", | ||
| Строка 144: | Строка 144: | ||
|} | |} | ||
===JSON-модель тела ответа=== | ===JSON-модель тела ответа=== | ||
< | <{ | ||
"id": "string", | "id": "string", | ||
"email": "string", | "email": "string", | ||
| Строка 161: | Строка 161: | ||
<code><nowiki>https://myManaged.cluster.com/api/v1.0/onpremise/users</nowiki></code> | <code><nowiki>https://myManaged.cluster.com/api/v1.0/onpremise/users</nowiki></code> | ||
====Тело ответа==== | ====Тело ответа==== | ||
< | <{ | ||
"id": "john.wicked", | "id": "john.wicked", | ||
"email": "john.wicked@company.com", | "email": "john.wicked@company.com", | ||
Версия от 13:24, 8 ноября 2024
Установка и настройка / Основные элементы АппОптима / АппОптима Managed / REST API / API Кластера v1 / Пользователи / Обновление информации о пользователе
Этот вызов API обновляет учетную запись пользователя кластера.
Аутентификация
Для выполнения этого запроса вам необходимо разрешение API (ServiceProviderAPI), назначенное вашему токену API. Создайте свой токен API с помощью консоли управления кластером (CMC). Чтобы узнать, как его получить и использовать, см. Аутентификация кластера.
Конечная точка
/api/v1.0/onpremise/users
Параметры
| Параметр | Тип | Описание | В | Обязательно |
|---|---|---|---|---|
| body | UserConfig | Тело запроса в формате JSON, содержащее параметры пользователя. | body | Нет |
Объекты тела запроса
Объект 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"
]
}
Ответ
Коды ответа
| Код | Тип | Описание |
|---|---|---|
| 200 | UserConfig | Успешно обновлено |
| 400 | Операция не удалась. Ввод недействителен. Возможные причины:
| |
| 403 | Операция запрещена — пользователи и группы полностью управляются через LDAP или SSO | |
| 404 | Не найдено | |
| 406 | Недопустимый запрос | |
| 524 | Адрес электронной почты уже зарегистрирован |
Объекты тела ответа
Объект 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, чтобы назначить только членство в группе admins. В ответ вы получите обратно текущее состояние сущности.
Curl
curl -X PUT "https://myManaged.cluster.com/api/v1.0/onpremise/users" -H "accept: application/json" -H "Content-Type: application/json" -d "{\"id\":\"john.wicked\",\"email\":\"john.wicked@company.com\",\"firstName\":\"John\",\"lastName\":\"Wicked\",\"passwordClearText\":null,\"groups\":[\"admin\"]}"
URL-адрес запроса
https://myManaged.cluster.com/api/v1.0/onpremise/users
Тело ответа
<{
"id": "john.wicked",
"email": "john.wicked@company.com",
"firstName": "John",
"lastName": "Wicked",
"passwordClearText": null,
"groups": [
"admin"
]
}
Код ответа
200