Создание нового пользователя: различия между версиями
(Новая страница: «Этот вызов API создает учетную запись пользователя кластера. ==Аутентификация== Для выполн...») |
ENetrebin (обсуждение | вклад) |
||
(не показаны 3 промежуточные версии 1 участника) | |||
Строка 1: | Строка 1: | ||
'''''[https://doc.ruscomtech.ru/index.php/%D0%A3%D1%81%D1%82%D0%B0%D0%BD%D0%BE%D0%B2%D0%BA%D0%B0_%D0%B8_%D0%BD%D0%B0%D1%81%D1%82%D1%80%D0%BE%D0%B9%D0%BA%D0%B0 Установка и настройка] / [https://doc.ruscomtech.ru/index.php/%D0%A3%D1%81%D1%82%D0%B0%D0%BD%D0%BE%D0%B2%D0%BA%D0%B0_%D0%B8_%D0%BD%D0%B0%D1%81%D1%82%D1%80%D0%BE%D0%B9%D0%BA%D0%B0#.D0.9E.D1.81.D0.BD.D0.BE.D0.B2.D0.BD.D1.8B.D0.B5_.D1.8D.D0.BB.D0.B5.D0.BC.D0.B5.D0.BD.D1.82.D1.8B_.D0.9A.D0.BB.D1.8E.D1.87-.D0.90.D1.81.D1.82.D1.80.D0.BE.D0.BC Основные элементы Ключ-Астром] / [https://doc.ruscomtech.ru/index.php/%D0%9A%D0%BB%D1%8E%D1%87-%D0%90%D0%A1%D0%A2%D0%A0%D0%9E%D0%9C_Managed Ключ-АСТРОМ Managed] / [https://doc.ruscomtech.ru/index.php/%D0%9A%D0%BB%D1%8E%D1%87-%D0%90%D0%A1%D0%A2%D0%A0%D0%9E%D0%9C_Managed#REST_API REST API] / [https://doc.ruscomtech.ru/index.php/API_%D0%9A%D0%BB%D0%B0%D1%81%D1%82%D0%B5%D1%80%D0%B0_v1 API Кластера v1] / [https://doc.ruscomtech.ru/index.php/API_%D0%9A%D0%BB%D0%B0%D1%81%D1%82%D0%B5%D1%80%D0%B0_v1#.D0.9F.D0.BE.D0.BB.D1.8C.D0.B7.D0.BE.D0.B2.D0.B0.D1.82.D0.B5.D0.BB.D0.B8 Пользователи] / Создание нового пользователя''''' | |||
Этот вызов API создает учетную запись пользователя кластера. | Этот вызов API создает учетную запись пользователя кластера. | ||
==Аутентификация== | ==Аутентификация== | ||
Строка 29: | Строка 31: | ||
!Тип | !Тип | ||
!Описание | !Описание | ||
!Обязательно | |||
|- | |- | ||
|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[] | ||
|Список идентификаторов групп пользователей пользователя. | |Список идентификаторов групп пользователей пользователя. | ||
|Нет | |||
|} | |} | ||
===JSON-модель тела запроса=== | ===JSON-модель тела запроса=== | ||
Строка 75: | Строка 84: | ||
|'''200''' | |'''200''' | ||
|UserConfig | |UserConfig | ||
| | |Пользователь добавлен | ||
|- | |- | ||
|'''400''' | |'''400''' |
Текущая версия на 14:19, 18 августа 2023
Установка и настройка / Основные элементы Ключ-Астром / Ключ-АСТРОМ Managed / REST API / API Кластера v1 / Пользователи / Создание нового пользователя
Этот вызов API создает учетную запись пользователя кластера.
Аутентификация
Для выполнения этого запроса вам необходимо разрешение API (ServiceProviderAPI)
, назначенное вашему токену API.
Через API требуется получить конфигурацию политики паролей и установить пароль, передав его значение в параметр passwordClearText
. Это возможно со включённым флагом Featured. Чтобы его включить, свяжитесь с командой Ключ-Астром.
Создайте свой токен 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