Открыть поиск
Открыть меню
656
701
11
6,2 тыс.
Документация АппОптима
Открыть персональное меню
Вы не представились системе
Your IP address will be publicly visible if you make any edits.

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

Материал из Документация АппОптима
Дополнительные действия
Нет описания правки
Нет описания правки
 
Строка 1: Строка 1:
'''''Установка и настройка / Основные элементы АппОптима / АппОптима Managed / REST API / API Кластера v1 / Пользователи / Создание пользователей кластера'''''
'''''Установка и настройка / Основные элементы АппОптима / АппОптима / REST API / API Кластера v1 / Пользователи / Создание пользователей кластера'''''


Этот вызов API создает несколько учетных записей пользователей кластера.
Этот вызов API создает несколько учетных записей пользователей кластера.
Строка 76: Строка 76:
     ]
     ]
   }
   }
  ]</code>
  ]
==Ответ==
==Ответ==
===Коды ответа===
===Коды ответа===
Строка 153: Строка 153:
     ]
     ]
   }
   }
  ]</code>
  ]
==Пример==
==Пример==
В этом примере мы добавляем двух пользователей — <code>john.wicked</code> и <code>ann.brown</code> в одном запросе. Это установит их данные и назначит индивидуальное членство в группе. В ответ вы получите обратно сохраненное состояние сущностей.
В этом примере мы добавляем двух пользователей — <code>john.wicked</code> и <code>ann.brown</code> в одном запросе. Это установит их данные и назначит индивидуальное членство в группе. В ответ вы получите обратно сохраненное состояние сущностей.
====Curl====
====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-адрес запроса====
====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>
====Тело ответа====
====Тело ответа====
  <[
  <[
Строка 181: Строка 181:
     "groups": ["users"]
     "groups": ["users"]
   }
   }
  ]</code>
  ]
====Код ответа====
====Код ответа====
<code>200</code>
<code>200</code>

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

Установка и настройка / Основные элементы АппОптима / АппОптима / 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

Источник — https://docs.expert-apm.ru/index.php?title=Создание_пользователей_кластера&oldid=5727
Последнее изменение