POST окончания ротации

Материал из Документация Ключ-АСТРОМ
Версия от 14:46, 25 октября 2022; ENetrebin (обсуждение | вклад) (Новая страница: «Завершает ротацию токена владельца. Старый токен становится недействительным. Выполняй...»)
(разн.) ← Предыдущая | Текущая версия (разн.) | Следующая → (разн.)

Завершает ротацию токена владельца. Старый токен становится недействительным. Выполняйте запрос только после обновления всех ЕдиныхАгентов и АктивныхШлюзов, как описано в разделе « Ротация токена владельца » .

Во избежание потери данных в процессе ротации действуют как старые, так и новые токены. Во время ротации не развертывайте никаких новых ЕдиныхАгентов, пока все ваши АктивныхШлюзов не будут настроены с использованием нового токена владельца.

Запрос создает application/jsonполезную нагрузку.

POST Managed https://{your-domain}/e/{your-environment-id}/api/v2/tenantTokenRotation/finish
Среда АктивногоШлюза https://{your-activegate-domain}/e/{your-environment-id}/api/v2/tenantTokenRotation/finish

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

Чтобы выполнить этот запрос, вам нужен токен доступа с областью ротации токенов владельца ( tenantTokenRotation.write) . Чтобы узнать, как его получить и использовать, см. раздел Токены и аутентификация .

Параметры

Запрос не предоставляет никаких настраиваемых параметров.

Ответ

Коды ответов

Код Тип Описание
200 TenantTokenConfig Успех. Процесс вращения завершен. Активное поле ответа содержит новый токен арендатора.
400 ErrorEnvelope Нет постоянного процесса ротации.

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

Объект TenantTokenConfig

Конфигурация токена арендатора .

Элемент Тип Описание
old TenantToken Токен владельца
active TenantToken Токен владельца

Объект TenantToken

Токен арендатора

Элемент Тип Описание
value string Секрет токена арендатора.

JSON-модель тела ответа

{
  "old": {
    "value": "string"
  },
  "active": {}
}

Пример

В этом примере запрос завершает процесс ротации, начатый в примере запуска запроса .

Код ответа 200 указывает на успешный запрос. Старый токен 1234567890qrstuvwxyz больше недействителен.

Маркер API передается в заголовке авторизации .

Curl

curl -X POST \
  https://mySampleEnv.live.ruscomtech.ru/api/v2/tenantTokenRotation/finish \
  -H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' \
  -H 'Accept: application/json'

Тело ответа

{
  "active": {
    "value": "zyxwvutsrq0987654321"
  },
  "old": {
    "value": "1234567890qrstuvwxyz"
  }
}

Код ответа

200