Открыть меню
Открыть персональное меню
Вы не представились системе
Your IP address will be publicly visible if you make any edits.

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

Материал из Документация АппОптима
(Новая страница: «Этот вызов API обновляет политику паролей кластера. ==Аутентификация== Для выполнения это...»)
 
Нет описания правки
 
(не показаны 2 промежуточные версии 2 участников)
Строка 1: Строка 1:
'''''Установка и настройка / Основные элементы АппОптима / АппОптима / REST API / API Кластера v1 / Политика паролей / Обновление политики паролей кластера'''''
Этот вызов 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 Аутентификация кластера].
Для выполнения этого запроса вам необходимо разрешение API <code>(ServiceProviderAPI)</code>, назначенное вашему токену API. Создайте свой токен API с помощью консоли управления кластером (CMC). Чтобы узнать, как его получить и использовать, см. Аутентификация кластера.
==Конечная точка==
==Конечная точка==
<code>/api/v1.0/onpremise/passwordPolicy</code>
<code>/api/v1.0/onpremise/passwordPolicy</code>
Строка 58: Строка 60:
=== JSON-модель тела запроса ===
=== JSON-модель тела запроса ===
Это модель тела запроса, показывающая возможные элементы. Его необходимо настроить для использования в реальном запросе.
Это модель тела запроса, показывающая возможные элементы. Его необходимо настроить для использования в реальном запросе.
  <code>{
  <{
   "minPasswordLength": 1,
   "minPasswordLength": 1,
   "minNumberOfUppercaseChars": 1,
   "minNumberOfUppercaseChars": 1,
Строка 64: Строка 66:
   "minNumberOfDigits": 1,
   "minNumberOfDigits": 1,
   "minNumberOfNonAlphanumericChars": 1
   "minNumberOfNonAlphanumericChars": 1
  }</code>
  }


==Ответ==
==Ответ==
Строка 87: Строка 89:


== Пример ==
== Пример ==
В этом примере вы обновляете политику паролей для управляемого развертывания <code>(myManaged.cluster.com)</code>. Вы определяете:
В этом примере вы обновляете политику паролей для управляемого развертывания <code>(myАппОптима.cluster.com)</code>. Вы определяете:


* Минимальную длина пароля
* Минимальную длина пароля
Строка 98: Строка 100:


====Curl====
====Curl====
  <code>curl -X PUT "<nowiki>https://myManaged.cluster.com/api/v1.0/onpremise/passwordPolicy</nowiki>" -H  "accept: */*" -H  "Content-Type: application/json" -d "{\"realmId\":\"string\",\"minPasswordLength\":16,\"minNumberOfUppercaseChars\":2,\"minNumberOfLowercaseChars\":4,\"minNumberOfDigits\":2,\"minNumberOfNonAlphanumericChars\":4}"</code>
  <code>curl -X PUT "<nowiki>https://myАппОптима.cluster.com/api/v1.0/onpremise/passwordPolicy</nowiki>" -H  "accept: */*" -H  "Content-Type: application/json" -d "{\"realmId\":\"string\",\"minPasswordLength\":16,\"minNumberOfUppercaseChars\":2,\"minNumberOfLowercaseChars\":4,\"minNumberOfDigits\":2,\"minNumberOfNonAlphanumericChars\":4}"</code>
====URL-адрес запроса====
====URL-адрес запроса====
  <code><nowiki>https://myManaged.cluster.com/api/v1.0/onpremise/passwordPolicy</nowiki></code>
  <code><nowiki>https://myАппОптима.cluster.com/api/v1.0/onpremise/passwordPolicy</nowiki></code>
====Тело ответа====
====Тело ответа====
<code>Успешно обновлено. Ответ не имеет тела.</code>
<code>Успешно обновлено. Ответ не имеет тела.</code>

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

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

Этот вызов API обновляет политику паролей кластера.

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

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

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

/api/v1.0/onpremise/passwordPolicy

Параметры

Параметр Тип Описание В Обязательно
body PasswordPolicy Тело JSON запроса. Содержит параметры конфигурации политики паролей. body Нет

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

Объект PasswordPolicy

Конфигурация политики паролей.

Элемент Тип Описание Обязательно
minPasswordLength integer Минимальная длина пароля Да
minNumberOfUppercaseChars integer Минимальное количество символов верхнего регистра Да
minNumberOfLowercaseChars integer Минимальное количество символов нижнего регистра Да
minNumberOfDigits integer Минимальное количество цифр Да
minNumberOfNonAlphanumericChars integer Минимальное количество специальных символов Да

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

Это модель тела запроса, показывающая возможные элементы. Его необходимо настроить для использования в реальном запросе.

<{
  "minPasswordLength": 1,
  "minNumberOfUppercaseChars": 1,
  "minNumberOfLowercaseChars": 1,
  "minNumberOfDigits": 1,
  "minNumberOfNonAlphanumericChars": 1
}

Ответ

Коды ответа

Код Тип Описание
204 Успешно обновлено. Ответ не имеет тела.
400 ErrorEnvelope Не удалось. Ввод недействителен.
404 Кластер не найден

Пример

В этом примере вы обновляете политику паролей для управляемого развертывания (myАппОптима.cluster.com). Вы определяете:

  • Минимальную длина пароля
  • Минимальное количество символов верхнего регистра
  • Минимальное количество символов нижнего регистра
  • Минимальное количество цифр
  • Минимальное количество специальных символов

В ответ вы получите код ответа 204, указывающий, что политика паролей была успешно обновлена.

Curl

curl -X PUT "https://myАппОптима.cluster.com/api/v1.0/onpremise/passwordPolicy" -H  "accept: */*" -H  "Content-Type: application/json" -d "{\"realmId\":\"string\",\"minPasswordLength\":16,\"minNumberOfUppercaseChars\":2,\"minNumberOfLowercaseChars\":4,\"minNumberOfDigits\":2,\"minNumberOfNonAlphanumericChars\":4}"

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

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

Тело ответа

Успешно обновлено. Ответ не имеет тела.

Код ответа

204