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

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

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

Этот вызов API удаляет пользователя кластера.

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

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

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

/api/v1.0/onpremise/users

Параметры

Параметр	Тип	Описание	В	Обязательно
id	string	Параметр пути идентификатора пользователя. Отсутствующие или пустые значения вернут «Bad Request».	path	Да

Ответ

Коды ответа

Код	Тип	Описание
200	UserConfig	Пользователь успешно удалён
304		Пользователь не удалён
400		Информация об ID пользователя не получена для запроса на удаление пользователя
406		Недопустимый запрос

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

Объект `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. Если учетная запись пользователя удалена, вы получите сведения об удаленном пользователе. Если пользователь был удален ранее, вы получите пустую полезную нагрузку ответа с кодом 200.

Curl

curl -X DELETE "https://myАппОптима.cluster.com/api/v1.0/onpremise/users/john.wicked" -H  "accept: application/json"

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

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

Тело ответа

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

Код ответа

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 удаляет пользователя кластера.
 ==Аутентификация==
-Для выполнения этого запроса вам необходимо разрешение 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/users</code>
@@ Строка 76: / Строка 76: @@
 |}
 ===JSON-модель тела ответа===
-  <code>{
+  <{
     "id": "string",
     "email": "string",
@@ Строка 85: / Строка 85: @@
       "string"
     ]
-  }</code>
+  }
 ==Пример==
 В этом примере вы удалите учетную запись пользователя <code>john.wicked</code>. Если учетная запись пользователя удалена, вы получите сведения об удаленном пользователе. Если пользователь был удален ранее, вы получите пустую полезную нагрузку ответа с кодом <code>200</code>.
 ====Curl====
-  <code>curl -X DELETE "<nowiki>https://myManaged.cluster.com/api/v1.0/onpremise/users/john.wicked</nowiki>" -H  "accept: application/json"</code>
+  <code>curl -X DELETE "<nowiki>https://myАппОптима.cluster.com/api/v1.0/onpremise/users/john.wicked</nowiki>" -H  "accept: application/json"</code>
 ====URL-адрес запроса====
-  <code><nowiki>https://mymanaged.cluster.com/api/v1.0/onpremise/users/john.wicked</nowiki></code>
+  <code><nowiki>https://myАппОптима.cluster.com/api/v1.0/onpremise/users/john.wicked</nowiki></code>
 ====Тело ответа====
-  <code>{
+  <{
       "id": "john.wicked",
       "email": "john.wicked@company.com",
@@ Строка 102: / Строка 102: @@
         "admin"
       ]
-    }</code>
+    }
 ====Код ответа====
 <code>200</code>