PUT токен

Материал из Документация Ключ-АСТРОМ

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

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

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

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

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

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

Параметры

Параметр Тип Описание In Необходимость
id string Идентификатор токена, который необходимо обновить.

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

path требуется
body ApiTokenUpdate Тело JSON запроса. Содержит обновленные параметры токена API. body требуется

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

Объект ApiTokenUpdate

Обновление токена API.

Элемент Тип Описание Необходимость
enabled boolean Маркер включен ( true) или отключен ( false) по желанию
scopes string[] Список областей, назначенных маркеру.

Помимо новых областей, вам также необходимо отправить существующие области, которые вы хотите сохранить. Любая существующая область, отсутствующая в полезной нагрузке, удаляется.

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

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

  • InstallerDownload
  • DataExport
  • PluginUpload
  • SupportAlert
  • AdvancedSyntheticIntegration
  • ExternalSyntheticIntegration
  • AppMonIntegration
  • RumBrowserExtension
  • LogExport
  • ReadConfig
  • WriteConfig
  • DTAQLAccess
  • UserSessionAnonymization
  • DataPrivacy
  • CaptureRequestData
  • AI
  • DssFileManagement
  • RumJavaScriptTagManagement
  • TenantTokenManagement
  • ActiveGateCertManagement
  • RestRequestForwarding
  • ReadSyntheticData
  • DataImport
  • syntheticExecutions.write
  • syntheticExecutions.read
  • auditLogs.read
  • metrics.read
  • metrics.write
  • entities.read
  • entities.write
  • problems.read
  • problems.write
  • events.read
  • events.ingest
  • networkZones.read
  • networkZones.write
  • activeGates.read
  • activeGates.write
  • activeGateTokenManagement.read
  • activeGateTokenManagement.create
  • activeGateTokenManagement.write
  • credentialVault.read
  • credentialVault.write
  • extensions.read
  • extensions.write
  • extensionConfigurations.read
  • extensionConfigurations.write
  • extensionEnvironment.read
  • extensionEnvironment.write
  • metrics.ingest
  • securityProblems.read
  • securityProblems.write
  • syntheticLocations.read
  • syntheticLocations.write
  • settings.read
  • settings.write
  • tenantTokenRotation.write
  • slo.read
  • slo.write
  • releases.read
  • apiTokens.read
  • apiTokens.write
  • openTelemetryTrace.ingest
  • logs.read
  • logs.ingest
  • geographicRegions.read
  • hub.read
  • oneAgents.read
  • oneAgents.write
  • traces.lookup
  • hub.write
 по желанию
name string Имя токена. по желанию

JSON-модель тела запроса

Это модель тела запроса, показывающая возможные элементы. Его необходимо настроить для использования в реальном запросе. 

{
  "enabled": true,
  "scopes": [
    "InstallerDownload"
  ],
  "name": "myToken"
}

Ответ

Коды ответов

Код Тип Описание
204 Успех. Ответ не имеет тела.
400 ErrorEnvelope Не удалось. Ввод недействителен.
Источник — https://doc.ruscomtech.ru/index.php?title=PUT_токен&oldid=2912