Создание нового пользователя: различия между версиями

Текущая версия от 08:57, 26 декабря 2024

Установка и настройка / Основные элементы АппОптима / АппОптима / 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 пользователя	Да
email	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		Операция не удалась. Ввод недействителен. Возможные причины: все необходимые значения (ID, адрес электронной почты, имя, фамилия) должны быть установлены неверные данные пользователя адрес электронной почты пользователя уже занят идентификатор группы пользователей не существует
403		Операция запрещена — пользователи и группы полностью управляются через LDAP или SSO
404		Не найдено
406		Недопустимый запрос
524		Адрес электронной почты уже зарегистрирован

Объекты тела ответа

Объект `UserConfig`

Конфигурация пользователя.

Элемент	Тип	Описание
id	string	ID пользователя
email	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://myАппОптима.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://myАппОптима.cluster.com/api/v1.0/onpremise/users

Тело ответа

<{
    "id": "john.wicked",
    "email": "john.wicked@company.com",
    "firstName": "John",
    "lastName": "Wicked",
    "passwordClearText": null,
    "groups": [
      "admin"
    ]
  }

Код ответа

200

@@ Строка 1: / Строка 1: @@
+'''''Установка и настройка / Основные элементы АппОптима / АппОптима / REST API / API Кластера v1 / Пользователи / Создание нового пользователя'''''
 Этот вызов API создает учетную запись пользователя кластера.
 ==Аутентификация==
 Для выполнения этого запроса вам необходимо разрешение API <code>(ServiceProviderAPI)</code>, назначенное вашему токену API.
-Через API требуется [[Получение политики паролей кластера|получить конфигурацию политики паролей]] и установить пароль, передав его значение в параметр <code>passwordClearText</code>. Это возможно со включённым флагом Featured. Чтобы его включить, свяжитесь с командой Ключ-Астром.
+Через API требуется [[Получение политики паролей кластера|получить конфигурацию политики паролей]] и установить пароль, передав его значение в параметр <code>passwordClearText</code>. Это возможно со включённым флагом Featured. Чтобы его включить, свяжитесь с командой АппОптима.
-Создайте свой токен 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 Аутентификация кластера].
+Создайте свой токен API с помощью консоли управления кластером (CMC). Чтобы узнать, как его получить и использовать, см. Аутентификация кластера.
 ==Конечная точка==
 <code>/api/v1.0/onpremise/users</code>
@@ Строка 29: / Строка 31: @@
 !Тип
 !Описание
+!Обязательно
 |-
 |id
 |string
 |ID пользователя
+|Да
 |-
 |email
 |string
 |Адрес электронной почты пользователя
+|Да
 |-
 |firstName
 |string
 |Имя пользователя
+|Да
 |-
 |lastName
 |string
 |Фамилия пользователя
+|Да
 |-
 |passwordClearText
 |string
 |Пароль пользователя открытым текстом; используется только для установки начального пароля
+|Нет
 |-
 |groups
 |string[]
 |Список идентификаторов групп пользователей пользователя.
+|Нет
 |}
 ===JSON-модель тела запроса===
 Это модель тела запроса, показывающая возможные элементы. Его необходимо настроить для использования в реальном запросе.
-  <code>{
+  <{
     "id": "string",
     "email": "string",
@@ Строка 65: / Строка 74: @@
       "string"
     ]
-  }</code>
+  }
 ==Ответ==
 ===Коды ответа===
@@ Строка 75: / Строка 84: @@
 |'''200'''
 |UserConfig
-|Успешно обновлено
+|Пользователь добавлен
 |-
 |'''400'''
@@ Строка 134: / Строка 143: @@
 |}
 ===JSON-модель тела ответа===
-  <code>{
+  <{
     "id": "string",
     "email": "string",
@@ Строка 143: / Строка 152: @@
       "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>
+  <code>curl -X PUT "<nowiki>https://myАппОптима.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><nowiki>https://myАппОптима.cluster.com/api/v1.0/onpremise/users</nowiki></code>
 ====Тело ответа====
-  <code>{
+  <{
       "id": "john.wicked",
       "email": "john.wicked@company.com",
@@ Строка 160: / Строка 169: @@
         "admin"
       ]
-    }</code>
+    }
 ====Код ответа====
 <code>200</code>

Текущая версия от 08:57, 26 декабря 2024

Аутентификация

Конечная точка

Параметры

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

Объект UserConfig

JSON-модель тела запроса

Ответ

Коды ответа

Объекты тела ответа

Объект UserConfig

JSON-модель тела ответа

Пример

Curl

URL-адрес запроса

Тело ответа

Код ответа

Объект `UserConfig`

Объект `UserConfig`