Обновление токена - История изменений

IKuznetsov в 17:00, 6 января 2025

2025-01-06T17:00:51Z

← Предыдущая версия		Версия от 17:00, 6 января 2025
Строка 1:		Строка 1:
			'''''[[Установка и настройка]] / [[Установка и настройка\|Основные элементы АппОптима]] / [[АппОптима]] / [[АппОптима\|REST API]] / [[API Кластера v2]] / [[API Кластера v2\|Токены]] / Обновление токена'''''

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

Строка 83:		Строка 85:
	"DiagnosticExport"		"DiagnosticExport"
	]		]
	}~~</code>~~		}
	==Ответ==		==Ответ==
	===Коды ответа===		===Коды ответа===
Строка 114:		Строка 116:
	"name": "updated token",		"name": "updated token",
	"scopes": ["UnattendedInstall"]		"scopes": ["UnattendedInstall"]
	}~~</code>~~		}

	==== Код ответа ====		==== Код ответа ====
	<code>204</code>		<code>204</code>

IKuznetsov в 13:29, 8 ноября 2024

2024-11-08T13:29:45Z

← Предыдущая версия		Версия от 13:29, 8 ноября 2024
Строка 6:		Строка 6:

	==Аутентификация==		==Аутентификация==
	Для выполнения этого запроса вам необходимо разрешение API <code>(ClusterTokenManagement)</code>, назначенное вашему токену API. Создайте свой токен API с помощью консоли управления кластером (CMC). Чтобы узнать, как его получить и использовать, см. ~~[https://doc.ruscomtech.ru/index.php/%D0%90%D1%83%D1%82%D0%B5%D0%BD%D1%82%D0%B8%D1%84%D0%B8%D0%BA%D0%B0%D1%86%D0%B8%D1%8F_%D0%BA%D0%BB%D0%B0%D1%81%D1%82%D0%B5%D1%80%D0%B0~~ Аутентификация кластера].		Для выполнения этого запроса вам необходимо разрешение API <code>(ClusterTokenManagement)</code>, назначенное вашему токену API. Создайте свой токен API с помощью консоли управления кластером (CMC). Чтобы узнать, как его получить и использовать, см. Аутентификация кластера.
	==Конечная точка==		==Конечная точка==
	<code>/api/cluster/v2/tokens</code>		<code>/api/cluster/v2/tokens</code>
Строка 77:		Строка 77:
	\|}		\|}
	====JSON-модель тела запроса====		====JSON-модель тела запроса====
	<~~code>~~{		<{
	"revoked": true,		"revoked": true,
	"name": "string",		"name": "string",
Строка 110:		Строка 110:
	<code><nowiki>https://myManaged.cluster.com/api/cluster/v2/tokens/4e9f128e-04f9-4795-pj319-8b7c-3c14a5e885e4</nowiki></code>		<code><nowiki>https://myManaged.cluster.com/api/cluster/v2/tokens/4e9f128e-04f9-4795-pj319-8b7c-3c14a5e885e4</nowiki></code>
	====Тело запроса====		====Тело запроса====
	<~~code>~~{		<{
	"revoked": "true",		"revoked": "true",
	"name": "updated token",		"name": "updated token",

RGolovanov в 14:03, 22 сентября 2022

2022-09-22T14:03:20Z

← Предыдущая версия		Версия от 14:03, 22 сентября 2022
Строка 103:		Строка 103:
	\|Не удалось. Запрошенный токен не найден.		\|Не удалось. Запрошенный токен не найден.
	\|}		\|}
	===Пример===		==Пример==
	В этом примере запрос запрашивает метаданные конкретного токена с идентификатором <code>4e9f128e-04f9-4795-pj319-8b7c-3c14a5e885e4</code>. Он изменяет область маркера, обновляя метаданные маркера. Имя и срок действия токена остаются неизменными. Код ответа <code>204</code> означает, что обновление прошло успешно.		В этом примере запрос запрашивает метаданные конкретного токена с идентификатором <code>4e9f128e-04f9-4795-pj319-8b7c-3c14a5e885e4</code>. Он изменяет область маркера, обновляя метаданные маркера. Имя и срок действия токена остаются неизменными. Код ответа <code>204</code> означает, что обновление прошло успешно.
	====Curl====		====Curl====

RGolovanov: Новая страница: «Этот вызов API обновляет указанный токен кластера. Вы можете: * Изменить имя токена. * Отоз...»

2022-09-22T13:59:05Z

Новая страница: «Этот вызов API обновляет указанный токен кластера. Вы можете: * Изменить имя токена. * Отоз...»

Новая страница

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

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

==Аутентификация==
Для выполнения этого запроса вам необходимо разрешение API <code>(ClusterTokenManagement)</code>, назначенное вашему токену API. Создайте свой токен API с помощью консоли управления кластером (CMC). Чтобы узнать, как его получить и использовать, см. [https://doc.ruscomtech.ru/index.php/%D0%90%D1%83%D1%82%D0%B5%D0%BD%D1%82%D0%B8%D1%84%D0%B8%D0%BA%D0%B0%D1%86%D0%B8%D1%8F_%D0%BA%D0%BB%D0%B0%D1%81%D1%82%D0%B5%D1%80%D0%B0 Аутентификация кластера].
==Конечная точка==
<code>/api/cluster/v2/tokens</code>
==Параметры==
{| class="wikitable"
!Параметр
!Тип
!Описание
!В
!Обязательно
|-
|id
|string
|Идентификатор токена, который необходимо обновить.

Вы не можете обновить токен, который используете для аутентификации запроса.
|path
|Да
|-
|body
|UpdateToken
|Тело JSON запроса. Содержит обновленные параметры токена.
|body
|Да
|}
===Объекты тела запроса===
====Объект <code>UpdateToken</code>====
{| class="wikitable"
!Элемент
!Тип
!Описание
!Обязательно
|-
|revoked
|boolean
|Токен отозван <code>(true)</code> или активен <code>(false)</code>.
|Нет
|-
|name
|string
|Имя токена.
|Да
|-
|expiresIn
|Duration
|Defines a period of time.
|Нет
|-
|scopes
|string[]
|Список областей, которые должны быть назначены токену.

* <code>DiagnosticExport</code>: Диагностический Экспорт.
* <code>ControlManagement</code>: КонтрольМенеджмента.
* <code>UnattendedInstall</code>: Автоматическая установка.
* <code>ServiceProviderAPI</code>: Service Provider API.
* <code>ExternalSyntheticIntegration</code>: Создание и чтение синтетических мониторов, местоположений и узлов.
* <code>ClusterTokenManagement</code>: Управление токенами кластера.
* <code>ReadSyntheticData</code>: Чтение синтетических мониторов, местоположений и узлов.
* <code>Nodekeeper</code>: Доступ к Nodekeeper для управления узлами.
* <code>EnvironmentTokenManagement</code>: «Управление токенами» Создание токенов для существующих сред.
* <code>activeGateTokenManagement.read</code>: Чтение токенов АктивногоШлюза.
* <code>activeGateTokenManagement.create</code>: Создание токенов АктивногоШлюза.
* <code>activeGateTokenManagement.write</code>: Запись токенов АктивногоШлюза.
* <code>settings.read</code>: Чтение настроек.
* <code>settings.write</code>: Записать настройки.
* <code>apiTokens.read</code>: Чтение токенов API.
* <code>apiTokens.write</code>: Написать токены API.
|Нет
|}
====JSON-модель тела запроса====
<code>{
"revoked": true,
"name": "string",
"scopes": [
"DiagnosticExport"
]
}</code>
==Ответ==
===Коды ответа===
{| class="wikitable"
!Код
!Тип
!Описание
|-
|'''204'''
|
|Успех. Токен обновлен.
|-
|'''400'''
|ErrorEnvelope
|Не удалось. Вы не можете обновить токен, который используете для аутентификации запроса.
|-
|'''404'''
|ErrorEnvelope
|Не удалось. Запрошенный токен не найден.
|}
===Пример===
В этом примере запрос запрашивает метаданные конкретного токена с идентификатором <code>4e9f128e-04f9-4795-pj319-8b7c-3c14a5e885e4</code>. Он изменяет область маркера, обновляя метаданные маркера. Имя и срок действия токена остаются неизменными. Код ответа <code>204</code> означает, что обновление прошло успешно.
====Curl====
<code>curl -X PUT "<nowiki>https://myManaged.cluster.com/api/cluster/v2/tokens/4e9f128e-04f9-4795-pj319-8b7c-3c14a5e885e4</nowiki>" -H "accept: application/json; charset=utf-8" -H "Content-Type: application/json; charset=utf-8" -d "{ \"revoked\": \"true\", \"name\": \"updated token\", \"scopes\": [ \"UnattendedInstall\" ]}"</code>
====URL-адрес запроса====
<code><nowiki>https://myManaged.cluster.com/api/cluster/v2/tokens/4e9f128e-04f9-4795-pj319-8b7c-3c14a5e885e4</nowiki></code>
====Тело запроса====
<code>{
"revoked": "true",
"name": "updated token",
"scopes": ["UnattendedInstall"]
}</code>

==== Код ответа ====
<code>204</code>