Обновление токена

Материал из Документация Ключ-АСТРОМ
Версия от 14:03, 22 сентября 2022; RGolovanov (обсуждение | вклад)
(разн.) ← Предыдущая | Текущая версия (разн.) | Следующая → (разн.)

Этот вызов API обновляет указанный токен кластера. Вы можете:

  • Изменить имя токена.
  • Отозвать токен. Отозванный токен все еще существует в среде, но его нельзя использовать.
  • Изменить область действия токена.

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

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

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

/api/cluster/v2/tokens

Параметры

Параметр Тип Описание В Обязательно
id string Идентификатор токена, который необходимо обновить.

Вы не можете обновить токен, который используете для аутентификации запроса.

path Да
body UpdateToken Тело JSON запроса. Содержит обновленные параметры токена. body Да

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

Объект UpdateToken

Элемент Тип Описание Обязательно
revoked boolean Токен отозван (true) или активен (false). Нет
name string Имя токена. Да
expiresIn Duration Defines a period of time. Нет
scopes string[] Список областей, которые должны быть назначены токену.
  • DiagnosticExport: Диагностический Экспорт.
  • ControlManagement: КонтрольМенеджмента.
  • UnattendedInstall: Автоматическая установка.
  • ServiceProviderAPI: Service Provider API.
  • ExternalSyntheticIntegration: Создание и чтение синтетических мониторов, местоположений и узлов.
  • ClusterTokenManagement: Управление токенами кластера.
  • ReadSyntheticData: Чтение синтетических мониторов, местоположений и узлов.
  • Nodekeeper: Доступ к Nodekeeper для управления узлами.
  • EnvironmentTokenManagement: «Управление токенами» Создание токенов для существующих сред.
  • activeGateTokenManagement.read: Чтение токенов АктивногоШлюза.
  • activeGateTokenManagement.create: Создание токенов АктивногоШлюза.
  • activeGateTokenManagement.write: Запись токенов АктивногоШлюза.
  • settings.read: Чтение настроек.
  • settings.write: Записать настройки.
  • apiTokens.read: Чтение токенов API.
  • apiTokens.write: Написать токены API.
Нет

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

{
  "revoked": true,
  "name": "string",
  "scopes": [
    "DiagnosticExport"
  ]
}

Ответ

Коды ответа

Код Тип Описание
204 Успех. Токен обновлен.
400 ErrorEnvelope Не удалось. Вы не можете обновить токен, который используете для аутентификации запроса.
404 ErrorEnvelope Не удалось. Запрошенный токен не найден.

Пример

В этом примере запрос запрашивает метаданные конкретного токена с идентификатором 4e9f128e-04f9-4795-pj319-8b7c-3c14a5e885e4. Он изменяет область маркера, обновляя метаданные маркера. Имя и срок действия токена остаются неизменными. Код ответа 204 означает, что обновление прошло успешно.

Curl

curl -X PUT "https://myManaged.cluster.com/api/cluster/v2/tokens/4e9f128e-04f9-4795-pj319-8b7c-3c14a5e885e4" -H  "accept: application/json; charset=utf-8" -H  "Content-Type: application/json; charset=utf-8" -d  "{  \"revoked\": \"true\",  \"name\": \"updated token\",  \"scopes\": [    \"UnattendedInstall\"  ]}"

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

https://myManaged.cluster.com/api/cluster/v2/tokens/4e9f128e-04f9-4795-pj319-8b7c-3c14a5e885e4

Тело запроса

{
  "revoked": "true",
  "name": "updated token",
  "scopes": ["UnattendedInstall"]
}

Код ответа

204