POST токен - История изменений

IKuznetsov в 17:27, 2 января 2025

2025-01-02T17:27:26Z

← Предыдущая версия		Версия от 17:27, 2 января 2025
Строка 1:		Строка 1:
			'''''[[API АппОптима]] / [[API АппОптима\|Эндпойнты среды]] / [https://docs.expert-apm.ru/index.php/API_%D0%90%D0%BF%D0%BF%D0%9E%D0%BF%D1%82%D0%B8%D0%BC%D0%B0#:~:text=DELETE%20%D1%82%D0%B5%D0%B3%D0%BE%D0%B2-,%D0%A0%D0%B0%D0%B7%D0%B2%D1%91%D1%80%D1%82%D1%8B%D0%B2%D0%B0%D0%BD%D0%B8%D0%B5,-%D0%BF%D1%80%D0%B0%D0%B2%D0%B8%D1%82%D1%8C Развёртывание] / [https://docs.expert-apm.ru/index.php/API_%D0%90%D0%BF%D0%BF%D0%9E%D0%BF%D1%82%D0%B8%D0%BC%D0%B0#:~:text=PUT%20%D0%BA%D0%BE%D0%BD%D1%84%D0%B8%D0%B3%D1%83%D1%80%D0%B0%D1%86%D0%B8%D1%8F-,%D0%A2%D0%BE%D0%BA%D0%B5%D0%BD%D1%8B%20v2,-%D0%A2%D0%BE%D0%BA%D0%B5%D0%BD%D1%8B%20%D0%B4%D0%BE%D1%81%D1%82%D1%83%D0%BF%D0%B0 Токены v2] / [https://docs.expert-apm.ru/index.php/API_%D0%90%D0%BF%D0%BF%D0%9E%D0%BF%D1%82%D0%B8%D0%BC%D0%B0#:~:text=%D0%A2%D0%BE%D0%BA%D0%B5%D0%BD%D1%8B%20v2-,%D0%A2%D0%BE%D0%BA%D0%B5%D0%BD%D1%8B%20%D0%B4%D0%BE%D1%81%D1%82%D1%83%D0%BF%D0%B0,-GET%20%D0%B2%D1%81%D0%B5%20%D1%82%D0%BE%D0%BA%D0%B5%D0%BD%D1%8B Токены доступа] / POST токен'''''

	Создает новый токен API.		Создает новый токен API.

IKuznetsov в 09:35, 26 декабря 2024

2024-12-26T09:35:31Z

← Предыдущая версия		Версия от 09:35, 26 декабря 2024
Строка 6:		Строка 6:
	{\| class="wikitable"		{\| class="wikitable"
	\| rowspan="2" \|POST		\| rowspan="2" \|POST
	\|~~Managed~~		\|АппОптима
	\|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/apiTokens</nowiki></code>		\|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/apiTokens</nowiki></code>
	\|-		\|-
Строка 233:		Строка 233:
	],		],
	"name": "tokenName"		"name": "tokenName"
	}~~</code>~~		}

	== Ответ ==		== Ответ ==
Строка 279:		Строка 279:
	"token": "dt0c01.ST2EY72KQINMH574WMNVI7YN.G3DFPBEJYMODIDAEX454M7YWBUVEFOWKPRVMWFASS64NFH52PX6BNDVFFM572RZM",		"token": "dt0c01.ST2EY72KQINMH574WMNVI7YN.G3DFPBEJYMODIDAEX454M7YWBUVEFOWKPRVMWFASS64NFH52PX6BNDVFFM572RZM",
	"id": "dt0c01.ST2EY72KQINMH574WMNVI7YN"		"id": "dt0c01.ST2EY72KQINMH574WMNVI7YN"
	}~~</code>~~		}

IKuznetsov в 03:22, 21 декабря 2024

2024-12-21T03:22:55Z

ENetrebin в 16:39, 6 июля 2023

2023-07-06T16:39:51Z

← Предыдущая версия		Версия от 16:39, 6 июля 2023
Строка 86:		Строка 86:
	* <code>DataPrivacy</code>: изменить настройки конфиденциальности данных.		* <code>DataPrivacy</code>: изменить настройки конфиденциальности данных.
	* <code>CaptureRequestData</code>: Захват данных запроса.		* <code>CaptureRequestData</code>: Захват данных запроса.
	* <code>~~Davis~~</code>: Интеграция модуля Ключ-АСТРОМ — ~~Davis~~.		* <code>ИИ</code>: Интеграция модуля Ключ-АСТРОМ — ИИ.
	* <code>DssFileManagement</code>: Управление файлами мобильных символов.		* <code>DssFileManagement</code>: Управление файлами мобильных символов.
	* <code>RumJavaScriptTagManagement</code>: Реальный пользователь контролирует управление тегами JavaScript.		* <code>RumJavaScriptTagManagement</code>: Реальный пользователь контролирует управление тегами JavaScript.
Строка 160:		Строка 160:
	* <code>DataPrivacy</code>		* <code>DataPrivacy</code>
	* <code>CaptureRequestData</code>		* <code>CaptureRequestData</code>
	* <code>~~Davis~~</code>		* <code>AI</code>
	* <code>DssFileManagement</code>		* <code>DssFileManagement</code>
	* <code>RumJavaScriptTagManagement</code>		* <code>RumJavaScriptTagManagement</code>

ENetrebin: Новая страница: «Создает новый токен API. Токен будет принадлежать пользователю, которому принадлежит ток...»

2022-10-25T12:44:55Z

Новая страница: «Создает новый токен API. Токен будет принадлежать пользователю, которому принадлежит ток...»

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

Создает новый токен API.

Токен будет принадлежать пользователю, которому принадлежит токен, используемый для аутентификации вызова.

Запрос создает и использует в качестве полезной нагрузки <code>application/json</code> формат.
{| class="wikitable"
| rowspan="2" |POST
|Managed
|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/apiTokens</nowiki></code>
|-
|Среда АктивногоШлюза
|<code><nowiki>https://{your-activegate-domain}/e/{your-environment-id}/api/v2/apiTokens</nowiki></code>
|}

== Аутентификация ==
Чтобы выполнить этот запрос, вам нужен токен доступа с областью действия Write API tokens ( <code>apiTokens.write</code>) . Чтобы узнать, как его получить и использовать, см. раздел [[Токены и аутентификация (API)|Токены и аутентификация]] .

== Параметры ==
{| class="wikitable"
!Параметр
!Тип
!Описание
!In
!Необходимость
|-
|body
|ApiTokenCreate
|Тело JSON запроса. Содержит параметры нового токена API.
|body
|требуется
|}

=== Объекты тела запроса ===

==== Объект <code>ApiTokenCreate</code> ====
Параметры нового токена API.
{| class="wikitable"
!Элемент
!Тип
!Описание
!Необходимость
|-
|personalAccessToken
|boolean
|Токен представляет собой токен личного доступа ( <code>true</code>) или токен API ( <code>false</code>).

Токены личного доступа привязаны к разрешениям их владельца.
|по желанию
|-
|expirationDate
|string
|Срок действия токена.

Вы можете использовать один из следующих форматов:

* Отметка времени в миллисекундах UTC.
* Человекочитаемый формат <code>2021-01-25T05:57:01.123+01:00</code>. Если часовой пояс не указан, используется UTC. Вы можете использовать пробел вместо <code>T</code>. Секунды и доли секунды не являются обязательными.
* Относительный таймфрейм, назад. Формат: <code>now-NU/A</code>, где <code>N</code>количество времени, <code>U</code>единица времени и <code>A</code>выравнивание. Выравнивание округляет все меньшие значения до ближайшего нуля в прошлом. Например, <code>now-1y/w</code>это один год назад, выровненный на неделю. Вы также можете указать относительный таймфрейм без выравнивания: <code>now-NU</code>. Поддерживаемые единицы времени для относительного таймфрейма:
** <code>m</code>: минуты
** <code>h</code>: часы
** <code>d</code>: дни
** <code>w</code>: недели
** <code>M</code>: месяцы
** <code>y</code>: годы

Если не установлено, срок действия токена никогда не истекает.
|по желанию
|-
|scopes
|string[]
|Список областей, которые должны быть назначены маркеру.

* <code>InstallerDownload</code>: Интеграция с PaaS — загрузка установщика.
* <code>DataExport</code>: доступ к ленте проблем и событий, метрикам и топологии.
* <code>PluginUpload</code>: Загрузить расширение.
* <code>SupportAlert</code>: Интеграция с PaaS - Оповещение о поддержке.
* <code>AdvancedSyntheticIntegration</code>: Интеграция модуля Ключ-АСТРОМ - Synthetic Classic.
* <code>ExternalSyntheticIntegration</code>: создание и чтение синтетических мониторов, местоположений и узлов.
* <code>AppMonIntegration</code>: Интеграция модуля Ключ-АСТРОМ - AppMon.
* <code>RumBrowserExtension</code>: Расширение для браузера RUM.
* <code>LogExport</code>: Читать журналы.
* <code>ReadConfig</code>: Чтение конфигурации.
* <code>WriteConfig</code>: Написать конфигурацию.
* <code>DTAQLAccess</code>: сеансы пользователей.
* <code>UserSessionAnonymization</code>: анонимизация данных сеанса пользователя по соображениям конфиденциальности данных.
* <code>DataPrivacy</code>: изменить настройки конфиденциальности данных.
* <code>CaptureRequestData</code>: Захват данных запроса.
* <code>Davis</code>: Интеграция модуля Ключ-АСТРОМ — Davis.
* <code>DssFileManagement</code>: Управление файлами мобильных символов.
* <code>RumJavaScriptTagManagement</code>: Реальный пользователь контролирует управление тегами JavaScript.
* <code>TenantTokenManagement</code>: Управление токенами.
* <code>ActiveGateCertManagement</code>: Управление сертификатами АктивногоШлюза.
* <code>RestRequestForwarding</code>: получение данных из удаленной среды.
* <code>ReadSyntheticData</code>: чтение синтетических мониторов, местоположений и узлов.
* <code>DataImport</code>: прием данных, например: метрики и события.
* <code>syntheticExecutions.write</code>: Написать синтетические исполнения монитора.
* <code>syntheticExecutions.read</code>: Чтение результатов выполнения синтетического монитора.
* <code>auditLogs.read</code>: чтение логов аудита.
* <code>metrics.read</code>: чтение метрик.
* <code>metrics.write</code>: Запись показателей.
* <code>entities.read</code>: Чтение записей.
* <code>entities.write</code>: Запись объектов.
* <code>problems.read</code>: Проблемы с чтением.
* <code>problems.write</code>: Пишите задачи.
* <code>events.read</code>: Чтение событий.
* <code>events.ingest</code>: прием событий.
* <code>networkZones.read</code>: Чтение сетевых зон.
* <code>networkZones.write</code>: Запись сетевых зон.
* <code>activeGates.read</code>: Чтение АктивныеШлюзы.
* <code>activeGates.write</code>: Запись АктивныеШлюзы.
* <code>activeGateTokenManagement.read</code>: Чтение токенов АктивногоШлюза.
* <code>activeGateTokenManagement.create</code>: создание токенов АктивногоШлюза.
* <code>activeGateTokenManagement.write</code>: Запись токенов АктивногоШлюза.
* <code>credentialVault.read</code>: Чтение записей хранилища учетных данных.
* <code>credentialVault.write</code>: запись записей хранилища учетных данных.
* <code>extensions.read</code>: Чтение расширения.
* <code>extensions.write</code>: Запись расширений.
* <code>extensionConfigurations.read</code>: Чтение конфигураций мониторинга расширений.
* <code>extensionConfigurations.write</code>: Запись конфигураций мониторинга расширений.
* <code>extensionEnvironment.read</code>: Чтение конфигураций среды расширения.
* <code>extensionEnvironment.write</code>: Запись конфигураций среды расширения.
* <code>metrics.ingest</code>: прием метрик.
* <code>securityProblems.read</code>: Прочитать проблемы с безопасностью.
* <code>securityProblems.write</code>: Напишите проблемы с безопасностью.
* <code>syntheticLocations.read</code>: Чтение синтетические локации.
* <code>syntheticLocations.write</code>: Запись синтетических локаций.
* <code>settings.read</code>: Чтение настроек.
* <code>settings.write</code>: Запись настроек.
* <code>tenantTokenRotation.write</code>: ротация токенов владельца.
* <code>slo.read</code>: Чтение SLO.
* <code>slo.write</code>: Запись SLO.
* <code>releases.read</code>: Чтение релизов.
* <code>apiTokens.read</code>: Чтение токенов API.
* <code>apiTokens.write</code>: Запись токенов API.
* <code>openTelemetryTrace.ingest</code>: прием трассировок OpenTelemetry.
* <code>logs.read</code>: Чтение логов.
* <code>logs.ingest</code>: прием журналов.
* <code>geographicRegions.read</code>: Чтение Географические регионы.
* <code>hub.read</code>: Чтение ХАБ.
* <code>oneAgents.read</code>: Чтение ЕдиныхАгентов.
* <code>oneAgents.write</code>: Запись ЕдиныхАгентов.
* <code>traces.lookup</code>: Поиск одной трассировки.
* <code>hub.write</code>: Запись данных, связанных с HUB.

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

* <code>InstallerDownload</code>
* <code>DataExport</code>
* <code>PluginUpload</code>
* <code>SupportAlert</code>
* <code>AdvancedSyntheticIntegration</code>
* <code>ExternalSyntheticIntegration</code>
* <code>AppMonIntegration</code>
* <code>RumBrowserExtension</code>
* <code>LogExport</code>
* <code>ReadConfig</code>
* <code>WriteConfig</code>
* <code>DTAQLAccess</code>
* <code>UserSessionAnonymization</code>
* <code>DataPrivacy</code>
* <code>CaptureRequestData</code>
* <code>Davis</code>
* <code>DssFileManagement</code>
* <code>RumJavaScriptTagManagement</code>
* <code>TenantTokenManagement</code>
* <code>ActiveGateCertManagement</code>
* <code>RestRequestForwarding</code>
* <code>ReadSyntheticData</code>
* <code>DataImport</code>
* <code>syntheticExecutions.write</code>
* <code>syntheticExecutions.read</code>
* <code>auditLogs.read</code>
* <code>metrics.read</code>
* <code>metrics.write</code>
* <code>entities.read</code>
* <code>entities.write</code>
* <code>problems.read</code>
* <code>problems.write</code>
* <code>events.read</code>
* <code>events.ingest</code>
* <code>networkZones.read</code>
* <code>networkZones.write</code>
* <code>activeGates.read</code>
* <code>activeGates.write</code>
* <code>activeGateTokenManagement.read</code>
* <code>activeGateTokenManagement.create</code>
* <code>activeGateTokenManagement.write</code>
* <code>credentialVault.read</code>
* <code>credentialVault.write</code>
* <code>extensions.read</code>
* <code>extensions.write</code>
* <code>extensionConfigurations.read</code>
* <code>extensionConfigurations.write</code>
* <code>extensionEnvironment.read</code>
* <code>extensionEnvironment.write</code>
* <code>metrics.ingest</code>
* <code>securityProblems.read</code>
* <code>securityProblems.write</code>
* <code>syntheticLocations.read</code>
* <code>syntheticLocations.write</code>
* <code>settings.read</code>
* <code>settings.write</code>
* <code>tenantTokenRotation.write</code>
* <code>slo.read</code>
* <code>slo.write</code>
* <code>releases.read</code>
* <code>apiTokens.read</code>
* <code>apiTokens.write</code>
* <code>openTelemetryTrace.ingest</code>
* <code>logs.read</code>
* <code>logs.ingest</code>
* <code>geographicRegions.read</code>
* <code>hub.read</code>
* <code>oneAgents.read</code>
* <code>oneAgents.write</code>
* <code>traces.lookup</code>
* <code>hub.write</code>
|требуется
|-
|name
|string
|Имя токена.
|требуется
|}

=== JSON-модель тела запроса ===
Это модель тела запроса, показывающая возможные элементы. Его необходимо настроить для использования в реальном запросе.
<code>{
"personalAccessToken": false,
"expirationDate": "now+14d",
"scopes": [
"metrics.read"
],
"name": "tokenName"
}</code>

== Ответ ==

=== Коды ответов ===
{| class="wikitable"
!Код
|Тип
!Описание
|-
|201
|ApiTokenCreated
|Успех. Токен создан. Тело ответа содержит секрет токена.
|-
|400
|ErrorEnvelope
|Не удалось. Ввод недействителен.
|}

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

==== Объект <code>ApiTokenCreated</code> ====
Недавно созданный токен.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|expirationDate
|string
|Дата истечения срока действия токена в формате ISO 8601 ( <code>yyyy-MM-dd'T'HH:mm:ss.SSS'Z'</code>).
|-
|token
|string
|Секрет токена.
|-
|id
|string
|Идентификатор токена, состоящий из префикса и общедоступной части токена.
|}

=== JSON-модель тела ответа ===
<code>{
"expirationDate": "2020-11-12T08:15:30.144Z",
"token": "dt0c01.ST2EY72KQINMH574WMNVI7YN.G3DFPBEJYMODIDAEX454M7YWBUVEFOWKPRVMWFASS64NFH52PX6BNDVFFM572RZM",
"id": "dt0c01.ST2EY72KQINMH574WMNVI7YN"
}</code>

← Предыдущая версия		Версия от 03:22, 21 декабря 2024
Строка 75:		Строка 75:
	* <code>PluginUpload</code>: Загрузить расширение.		* <code>PluginUpload</code>: Загрузить расширение.
	* <code>SupportAlert</code>: Интеграция с PaaS - Оповещение о поддержке.		* <code>SupportAlert</code>: Интеграция с PaaS - Оповещение о поддержке.
	* <code>AdvancedSyntheticIntegration</code>: Интеграция модуля ~~Ключ-АСТРОМ~~ - Synthetic Classic.		* <code>AdvancedSyntheticIntegration</code>: Интеграция модуля АппОптима - Synthetic Classic.
	* <code>ExternalSyntheticIntegration</code>: создание и чтение синтетических мониторов, местоположений и узлов.		* <code>ExternalSyntheticIntegration</code>: создание и чтение синтетических мониторов, местоположений и узлов.
	* <code>AppMonIntegration</code>: Интеграция модуля ~~Ключ-АСТРОМ~~ - AppMon.		* <code>AppMonIntegration</code>: Интеграция модуля АппОптима - AppMon.
	* <code>RumBrowserExtension</code>: Расширение для браузера RUM.		* <code>RumBrowserExtension</code>: Расширение для браузера RUM.
	* <code>LogExport</code>: Читать журналы.		* <code>LogExport</code>: Читать журналы.
Строка 86:		Строка 86:
	* <code>DataPrivacy</code>: изменить настройки конфиденциальности данных.		* <code>DataPrivacy</code>: изменить настройки конфиденциальности данных.
	* <code>CaptureRequestData</code>: Захват данных запроса.		* <code>CaptureRequestData</code>: Захват данных запроса.
	* <code>ИИ</code>: Интеграция модуля ~~Ключ-АСТРОМ~~ — ИИ.		* <code>ИИ</code>: Интеграция модуля АппОптима — ИИ.
	* <code>DssFileManagement</code>: Управление файлами мобильных символов.		* <code>DssFileManagement</code>: Управление файлами мобильных символов.
	* <code>RumJavaScriptTagManagement</code>: Реальный пользователь контролирует управление тегами JavaScript.		* <code>RumJavaScriptTagManagement</code>: Реальный пользователь контролирует управление тегами JavaScript.
Строка 226:		Строка 226:
	=== JSON-модель тела запроса ===		=== JSON-модель тела запроса ===
	Это модель тела запроса, показывающая возможные элементы. Его необходимо настроить для использования в реальном запросе.		Это модель тела запроса, показывающая возможные элементы. Его необходимо настроить для использования в реальном запросе.
	<~~code>~~{		<{
	"personalAccessToken": false,		"personalAccessToken": false,
	"expirationDate": "now+14d",		"expirationDate": "now+14d",
Строка 275:		Строка 275:

	=== JSON-модель тела ответа ===		=== JSON-модель тела ответа ===
	<~~code>~~{		<{
	"expirationDate": "2020-11-12T08:15:30.144Z",		"expirationDate": "2020-11-12T08:15:30.144Z",
	"token": "dt0c01.ST2EY72KQINMH574WMNVI7YN.G3DFPBEJYMODIDAEX454M7YWBUVEFOWKPRVMWFASS64NFH52PX6BNDVFFM572RZM",		"token": "dt0c01.ST2EY72KQINMH574WMNVI7YN.G3DFPBEJYMODIDAEX454M7YWBUVEFOWKPRVMWFASS64NFH52PX6BNDVFFM572RZM",
	"id": "dt0c01.ST2EY72KQINMH574WMNVI7YN"		"id": "dt0c01.ST2EY72KQINMH574WMNVI7YN"
	}</code>		}</code>