RGolovanov в 17:25, 16 сентября 2022

2022-09-16T17:25:36Z

← Предыдущая		Версия 17:25, 16 сентября 2022
Строка 27:		Строка 27:
	!Тип		!Тип
	!Описание		!Описание
			!Обязательно
	\|-		\|-
	\|id		\|id
	\|string		\|string
	\|ID пользователя		\|ID пользователя
			\|Да
	\|-		\|-
	\|email		\|email
	\|string		\|string
	\|Адрес электронной почты пользователя		\|Адрес электронной почты пользователя
			\|Да
	\|-		\|-
	\|firstName		\|firstName
	\|string		\|string
	\|Имя пользователя		\|Имя пользователя
			\|Да
	\|-		\|-
	\|lastName		\|lastName
	\|string		\|string
	\|Фамилия пользователя		\|Фамилия пользователя
			\|Да
	\|-		\|-
	\|passwordClearText		\|passwordClearText
	\|string		\|string
	\|Пароль пользователя открытым текстом; используется только для установки начального пароля		\|Пароль пользователя открытым текстом; используется только для установки начального пароля
			\|Нет
	\|-		\|-
	\|groups		\|groups
	\|string[]		\|string[]
	\|Список идентификаторов групп пользователей пользователя.		\|Список идентификаторов групп пользователей пользователя.
			\|Нет
	\|}		\|}

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

2022-09-16T17:15:04Z

Новая страница: «Этот вызов 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"
!Параметр
!Тип
!Описание
!В
!Обязательно
|-
|body
|UserConfig
|Тело запроса в формате JSON, содержащее параметры пользователя.
|body
|Нет
|}

=== Объекты тела запроса ===

==== Объект <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>

==Ответ==
===Коды ответа===
{| class="wikitable"
!Код
|'''Тип'''
!Описание
|-
|'''200'''
|UserConfig
|Успешно обновлено
|-
|'''400'''
|
|Операция не удалась. Ввод недействителен. Возможные причины:

* все необходимые значения (ID, адрес электронной почты, имя, фамилия) должны быть установлены
* неверные данные пользователя
* адрес электронной почты пользователя уже занят
* идентификатор группы пользователей не существует
|-
|'''403'''
|
|Операция запрещена — пользователи и группы полностью управляются через LDAP или SSO
|-
|'''404'''
|
|Не найдено
|-
|'''406'''
|
|Недопустимый запрос
|-
|'''524'''
|
|Адрес электронной почты уже зарегистрирован
|}
===Объекты тела ответа===
====Объект <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>
==Пример==
В этом примере вы обновляете пользователя <code>john.wicked</code>, чтобы назначить только членство в группе <code>admins</code>. В ответ вы получите обратно текущее состояние сущности.
====Curl====
<code>curl -X PUT "<nowiki>https://myManaged.cluster.com/api/v1.0/onpremise/users</nowiki>" -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\"]}"</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": [
"admin"
]
}</code>
====Код ответа====
<code>200</code>

Обновление информации о пользователе - История изменений

RGolovanov в 17:25, 16 сентября 2022

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