Обновление информации о пользователе

Материал из Dynatrace
Версия от 17:25, 16 сентября 2022; RGolovanov (обсуждение | вклад)
(разн.) ← Предыдущая | Текущая версия (разн.) | Следующая → (разн.)

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

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

Для выполнения этого запроса вам необходимо разрешение API (ServiceProviderAPI), назначенное вашему токену API. Создайте свой токен 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://myManaged.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://myManaged.cluster.com/api/v1.0/onpremise/users

Тело ответа

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

Код ответа

200