POST старт ротации

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

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

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

Запрос создает в качестве полезной нагрузки application/json формат.

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

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

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

Параметры

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

Ответ

Коды ответов

Код Тип Описание
200 TenantTokenConfig Успех. Создан новый токен арендатора, который заменит старый. Активное поле ответа содержит новый токен владельца.
400 ErrorEnvelope Не удалось. Другой процесс ротации уже идет.

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

Объект _ TenantTokenConfig

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

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

Объект TenantToken

Токен владельца

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

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

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

Пример

В этом примере запрос запускает процесс ротации для среды mySampleEnv .

Код ответа 200 указывает на успешный запрос. Новый сгенерированный токен — zyxwvutsrq0987654321 .

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

Curl

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

Тело ответа

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

Код ответа

200