POST отмены ротации: различия между версиями
ENetrebin (обсуждение | вклад) (Новая страница: «Отменяет ротацию токена клиента. Новый токен отбрасывается, а старый остается действите...») |
ENetrebin (обсуждение | вклад) (→Curl) |
||
| Строка 81: | Строка 81: | ||
==== Curl ==== | ==== Curl ==== | ||
<code>curl -X POST \ | <code>curl -X POST \ | ||
https://mySampleEnv.live.ruscomtech.ru | <nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v2/tenantTokenRotation/finish</nowiki> \ | ||
-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' \ | -H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' \ | ||
-H 'Accept: application/json'</code> | -H 'Accept: application/json'</code> | ||
Версия 15:01, 25 октября 2022
Отменяет ротацию токена клиента. Новый токен отбрасывается, а старый остается действительным. Если вы настроили какие-либо ЕдиныеАгенты и АктивныеШлюзы для использования нового токена, вы должны восстановить старую конфигурацию.
Запрос создает в качестве полезной нагрузкиapplication/json формат.
| POST | Managed | https://{your-domain}/e/{your-environment-id}/api/v2/tenantTokenRotation/cancel
|
| Cреда АктивногоШлюза | https://{your-activegate-domain}/e/{your-environment-id}/api/v2/tenantTokenRotation/cancel
|
Аутентификация
Чтобы выполнить этот запрос, вам нужен токен доступа с областью ротации токенов владельца ( 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": "1234567890qrstuvwxyz"
},
"old": {
"value": null
}
}
Код ответа
200