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

Текущая версия от 15:56, 6 января 2025

Установка и настройка / Основные элементы АппОптима / АппОптима / REST API / API Кластера v1 / Пользователи / Создание пользователей кластера

Этот вызов API создает несколько учетных записей пользователей кластера.

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

Для выполнения этого запроса вам необходимо разрешение API (ServiceProviderAPI), назначенное вашему токену API.

Через API требуется получить конфигурацию политики паролей и установить пароль, передав его значение в параметр passwordClearText. Это возможно со включённым флагом Featured. Чтобы его включить, свяжитесь с командой АппОптима.

Создайте свой токен API с помощью консоли управления кластером (CMC). Чтобы узнать, как его получить и использовать, см. Аутентификация кластера.

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

/api/v1.0/onpremise/users/bulk

Параметры

Параметр	Тип	Описание	В	Обязательно
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 с интеграцией группового назначения
406	UserConfig	Неприемлемый или неполный запрос. Некоторые пользователи добавлены

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

Объект `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 и ann.brown в одном запросе. Это установит их данные и назначит индивидуальное членство в группе. В ответ вы получите обратно сохраненное состояние сущностей.

Curl

curl -X POST "https://myАппОптима.cluster.com/api/v1.0/onpremise/users/bulk" -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\":[\"owners\",\"users\"]},{\"id\":\"anne.brown\",\"email\":\"anne.brown@company.com\",\"firstName\":\"Anne\",\"lastName\":\"Brown\",\"passwordClearText\":null,\"groups\":[\"users\"]}]"

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

https://myАппОптима.cluster.com/api/v1.0/onpremise/users/bulk

Тело ответа

<[
  {
    "id": "john.wicked",
    "email": "john.wicked@company.com",
    "firstName": "John",
    "lastName": "Wicked",
    "passwordClearText": null,
    "groups": [
      "owners",
      "users"
    ]
  },
  {
    "id": "anne.brown",
    "email": "anne.brown@company.com",
    "firstName": "Anne",
    "lastName": "Brown",
    "passwordClearText": null,
    "groups": ["users"]
  }
]

Код ответа

200

@@ Строка 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 Пользователи] / Создание пользователей кластера'''''
+'''''[[Установка и настройка]] / [[Установка и настройка|Основные элементы АппОптима]] / [[АппОптима]] / [[АппОптима|REST API]] / [[API Кластера v1]] / [[API Кластера v1|Пользователи]] / Создание пользователей кластера'''''
 Этот вызов API создает несколько учетных записей пользователей кластера.
@@ Строка 5: / Строка 5: @@
 Для выполнения этого запроса вам необходимо разрешение API <code>(ServiceProviderAPI)</code>, назначенное вашему токену API.
-Через API требуется [https://doc.ruscomtech.ru/index.php/%D0%9F%D0%BE%D0%BB%D1%83%D1%87%D0%B5%D0%BD%D0%B8%D0%B5_%D0%BF%D0%BE%D0%BB%D0%B8%D1%82%D0%B8%D0%BA%D0%B8_%D0%BF%D0%B0%D1%80%D0%BE%D0%BB%D0%B5%D0%B9_%D0%BA%D0%BB%D0%B0%D1%81%D1%82%D0%B5%D1%80%D0%B0 получить конфигурацию политики паролей] и установить пароль, передав его значение в параметр <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/bulk</code>
@@ Строка 65: / Строка 65: @@
 ===JSON-модель тела запроса===
 Это модель тела запроса, показывающая возможные элементы. Его необходимо настроить для использования в реальном запросе.
-  <code>[
+  <[
     {
       "id": "string",
@@ Строка 76: / Строка 76: @@
       ]
     }
-  ]</code>
+  ]
 ==Ответ==
 ===Коды ответа===
@@ Строка 142: / Строка 142: @@
 |}
 ===JSON-модель тела ответа===
-  <code>[
+  <[
     {
       "id": "string",
@@ Строка 153: / Строка 153: @@
       ]
     }
-  ]</code>
+  ]
 ==Пример==
 В этом примере мы добавляем двух пользователей — <code>john.wicked</code> и <code>ann.brown</code> в одном запросе. Это установит их данные и назначит индивидуальное членство в группе. В ответ вы получите обратно сохраненное состояние сущностей.
 ====Curl====
-  <code>curl -X POST "<nowiki>https://myManaged.cluster.com/api/v1.0/onpremise/users/bulk</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\":[\"owners\",\"users\"]},{\"id\":\"anne.brown\",\"email\":\"anne.brown@company.com\",\"firstName\":\"Anne\",\"lastName\":\"Brown\",\"passwordClearText\":null,\"groups\":[\"users\"]}]"</code>
+  <code>curl -X POST "<nowiki>https://myАппОптима.cluster.com/api/v1.0/onpremise/users/bulk</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\":[\"owners\",\"users\"]},{\"id\":\"anne.brown\",\"email\":\"anne.brown@company.com\",\"firstName\":\"Anne\",\"lastName\":\"Brown\",\"passwordClearText\":null,\"groups\":[\"users\"]}]"</code>
 ====URL-адрес запроса====
-  <code><nowiki>https://myManaged.cluster.com/api/v1.0/onpremise/users/bulk</nowiki></code>
+  <code><nowiki>https://myАппОптима.cluster.com/api/v1.0/onpremise/users/bulk</nowiki></code>
 ====Тело ответа====
-  <code>[
+  <[
     {
       "id": "john.wicked",
@@ Строка 181: / Строка 181: @@
       "groups": ["users"]
     }
-  ]</code>
+  ]
 ====Код ответа====
 <code>200</code>

Текущая версия от 15:56, 6 января 2025

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

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

Параметры

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

Объект UserConfig

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

Ответ

Коды ответа

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

Объект UserConfig

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

Пример

Curl

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

Тело ответа

Код ответа

Объект `UserConfig`

Объект `UserConfig`