Создание нового токена - История изменений

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

2025-01-06T17:00:22Z

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

	Этот вызов API создает новый токен кластера.		Этот вызов API создает новый токен кластера.
	==Аутентификация==		==Аутентификация==
Строка 95:		Строка 97:
	"DiagnosticExport"		"DiagnosticExport"
	]		]
	}~~</code>~~		}
	==Ответ==		==Ответ==
	===Коды ответа===		===Коды ответа===
Строка 125:		Строка 127:
	<{		<{
	"token": "abcdefjhij1234567890"		"token": "abcdefjhij1234567890"
	}~~</code>~~		}
	==Пример==		==Пример==
	В этом примере запрос создает новый токен с именем <code>Mytoken</code>, действительный в течение 24 часов. С помощью этого токена вы сможете выполнять диагностический экспорт <code>(DiagnosticExport)</code> и автоматическую установку <code>(UnattendedInstall)</code>.		В этом примере запрос создает новый токен с именем <code>Mytoken</code>, действительный в течение 24 часов. С помощью этого токена вы сможете выполнять диагностический экспорт <code>(DiagnosticExport)</code> и автоматическую установку <code>(UnattendedInstall)</code>.
Строка 140:		Строка 142:
	"unit": "HOURS"		"unit": "HOURS"
	}		}
	}~~</code>~~		}

	==== Тело ответа ====		==== Тело ответа ====
	<{		<{
	"token": "abcdefjhij1234567890"		"token": "abcdefjhij1234567890"
	}~~</code>~~		}
	====Код ответа====		====Код ответа====
	<code>201</code>		<code>201</code>

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

2024-11-08T13:29:36Z

← Предыдущая версия		Версия от 13:29, 8 ноября 2024
Строка 1:		Строка 1:
	Этот вызов 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~~ Аутентификация кластера].		Для выполнения этого запроса вам необходимо разрешение API <code>(ClusterTokenManagement)</code>, назначенное вашему токену API. Создайте свой токен API с помощью консоли управления кластером (CMC). Чтобы узнать, как его получить и использовать, см. Аутентификация кластера.
	==Конечная точка==		==Конечная точка==
	<code>/api/cluster/v2/tokens</code>		<code>/api/cluster/v2/tokens</code>
Строка 86:		Строка 86:
	\|}		\|}
	====JSON-модель тела запроса====		====JSON-модель тела запроса====
	<~~code>~~{		<{
	"name": "string",		"name": "string",
	"expiresIn": {		"expiresIn": {
Строка 123:		Строка 123:
	\|}		\|}
	===JSON-модель тела ответа===		===JSON-модель тела ответа===
	<~~code>~~{		<{
	"token": "abcdefjhij1234567890"		"token": "abcdefjhij1234567890"
	}</code>		}</code>
Строка 133:		Строка 133:
	<code><nowiki>https://myManaged.cluster.com/api/cluster/v2/tokens</nowiki></code>		<code><nowiki>https://myManaged.cluster.com/api/cluster/v2/tokens</nowiki></code>
	====Тело запроса====		====Тело запроса====
	<~~code>~~{		<{
	"name": "MyToken",		"name": "MyToken",
	"scopes": ["DiagnosticExport", "UnattendedInstall"],		"scopes": ["DiagnosticExport", "UnattendedInstall"],
Строка 143:		Строка 143:

	==== Тело ответа ====		==== Тело ответа ====
	<~~code>~~{		<{
	"token": "abcdefjhij1234567890"		"token": "abcdefjhij1234567890"
	}</code>		}</code>
	====Код ответа====		====Код ответа====
	<code>201</code>		<code>201</code>

RGolovanov: /* Объект CreateToken */

2022-09-22T13:57:15Z

Объект CreateToken

← Предыдущая версия		Версия от 13:57, 22 сентября 2022
Строка 19:		Строка 19:
	\|}		\|}
	===Объекты тела запроса===		===Объекты тела запроса===
	====Объект CreateToken====		====Объект <code>CreateToken</code>====
	{\| class="wikitable"		{\| class="wikitable"
	!Элемент		!Элемент

RGolovanov в 13:55, 22 сентября 2022

2022-09-22T13:55:45Z

← Предыдущая версия		Версия от 13:55, 22 сентября 2022
Строка 1:		Строка 1:
	Этот вызов API создает новый токен кластера.		Этот вызов API создает новый токен кластера.
	==Аутентификация==		==Аутентификация==
	Для выполнения этого запроса вам необходимо разрешение API <code>(~~ServiceProviderAPI~~)</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). Чтобы узнать, как его получить и использовать, см. [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>		<code>/api/cluster/v2/tokens</code>

RGolovanov: Новая страница: «Этот вызов API создает новый токен кластера. ==Аутентификация== Для выполнения этого запро...»

2022-09-22T13:53:51Z

Новая страница: «Этот вызов API создает новый токен кластера. ==Аутентификация== Для выполнения этого запро...»

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

Этот вызов API создает новый токен кластера.
==Аутентификация==
Для выполнения этого запроса вам необходимо разрешение API <code>(ServiceProviderAPI)</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"
!Параметр
!Тип
!Описание
!В
!Обязательно
|-
|body
|CreateToken
|Тело JSON запроса. Содержит параметры нового токена.
|body
|Да
|}
===Объекты тела запроса===
====Объект CreateToken====
{| class="wikitable"
!Элемент
!Тип
!Описание
!Обязательно
|-
|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.
|Нет
|}
====Объект <code>Duration</code>====
{| class="wikitable"
!Элемент
!Тип
!Описание
!Обязательно
|-
|value
|integer
|Количество времени.
|Да
|-
|unit
|string
|Единица времени.

Если не установлено, используется миллисекунда.

Элемент может содержать эти значения:

* <code>DAYS</code>
* <code>HOURS</code>
* <code>MILLIS</code>
* <code>MINUTES</code>
* <code>SECONDS</code>
|Нет
|}
====JSON-модель тела запроса====
<code>{
"name": "string",
"expiresIn": {
"value": 1,
"unit": "DAYS"
},
"scopes": [
"DiagnosticExport"
]
}</code>
==Ответ==
===Коды ответа===
{| class="wikitable"
!Код
!Тип
!Описание
|-
|'''201'''
|Token
|Успех. Токен создан. Тело ответа содержит сам токен.
|-
|'''400'''
|ErrorEnvelope
|Не удалось. Ввод недействителен. Тело ответа содержит подробные сведения.
|}
===Объекты тела ответа===
====Объект <code>Token</code>====
{| class="wikitable"
!Element
!Type
!Description
|-
|token
|string
|Токен аутентификации API.
|}
===JSON-модель тела ответа===
<code>{
"token": "abcdefjhij1234567890"
}</code>
==Пример==
В этом примере запрос создает новый токен с именем <code>Mytoken</code>, действительный в течение 24 часов. С помощью этого токена вы сможете выполнять диагностический экспорт <code>(DiagnosticExport)</code> и автоматическую установку <code>(UnattendedInstall)</code>.
====Curl====
<code>curl -X POST "<nowiki>https://myManaged.cluster.com/api/cluster/v2/tokens</nowiki>" -H "accept: application/json; charset=utf-8" -H "Content-Type: application/json; charset=utf-8" -d "{ \"name\": \"MyToken\", \"scopes\": [ \"DiagnosticExport\", \"UnattendedInstall\" ], \"expiresIn\": { \"value\": 24, \"unit\": \"HOURS\" }}"</code>
====URL-адрес запроса====
<code><nowiki>https://myManaged.cluster.com/api/cluster/v2/tokens</nowiki></code>
====Тело запроса====
<code>{
"name": "MyToken",
"scopes": ["DiagnosticExport", "UnattendedInstall"],
"expiresIn": {
"value": 24,
"unit": "HOURS"
}
}</code>

==== Тело ответа ====
<code>{
"token": "abcdefjhij1234567890"
}</code>
====Код ответа====
<code>201</code>