POST поиск токена

Материал из Документация Ключ-АСТРОМ
Версия от 12:29, 25 октября 2022; ENetrebin (обсуждение | вклад) (Новая страница: «Получает метаданные токена API по его секрету. Запрос создает и использует в качестве пол...»)
(разн.) ← Предыдущая | Текущая версия (разн.) | Следующая → (разн.)

Получает метаданные токена API по его секрету.

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

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

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

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

Параметры

Параметр Тип Описание In Необходимость
body ApiTokenSecret Тело JSON запроса. Содержит требуемый токен. body требуется

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

Объект ApiTokenSecret

Элемент Тип Описание Необходимость
token string Токен API требуется

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

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

{
  "token": "dt0c01.ST2EY72KQINMH574WMNVI7YN.G3DFPBEJYMODIDAEX454M7YWBUVEFOWKPRVMWFASS64NFH52PX6BNDVFFM572RZM"
}

Ответ

Коды ответов

Код Тип Описание
200 ApiToken Успех
404 Не удалось. Запрошенный ресурс не существует.

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

Объект ApiToken

Метаданные токена API.

Элемент Тип Описание
lastUsedIpAddress string Последний использованный токеном IP-адрес.
modifiedDate string Дата последнего изменения токена в формате ISO 8601 ( yyyy-MM-dd'T'HH:mm:ss.SSS'Z'). Обновление областей действия или имени считается модификацией, а включение или отключение токена — нет.
additionalMetadata object Содержит дополнительные свойства для определенных типов токенов. Примеры:
  • dashboardIdСвойство для токенов совместного использования панели мониторинга .
  • reportIdСвойство для токенов общего доступа к отчетам
expirationDate string Срок действия токена в формате ISO 8601 ( yyyy-MM-dd'T'HH:mm:ss.SSS'Z').

Если не установлено, срок действия токена никогда не истекает.

personalAccessToken boolean Токен представляет собой токен личного доступа ( true) или токен API ( false).
lastUsedDate string Дата последнего использования токена в формате ISO 8601 ( yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
creationDate string Дата создания токена в формате ISO 8601 ( yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
enabled boolean Маркер включен ( true) или отключен ( false).
scopes string[] Список областей, назначенных маркеру.

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

  • ActiveGateCertManagement
  • AdvancedSyntheticIntegration
  • AppMonIntegration
  • CaptureRequestData
  • DTAQLAccess
  • DataExport
  • DataImport
  • DataPrivacy
  • Davis
  • DiagnosticExport
  • DssFileManagement
  • ExternalSyntheticIntegration
  • InstallerDownload
  • LogExport
  • MemoryDump
  • Mobile
  • PluginUpload
  • ReadConfig
  • ReadSyntheticData
  • RestRequestForwarding
  • RumBrowserExtension
  • RumJavaScriptTagManagement
  • SupportAlert
  • TenantTokenManagement
  • UserSessionAnonymization
  • ViewDashboard
  • ViewReport
  • WriteConfig
  • WriteSyntheticData
  • activeGateTokenManagement.create
  • activeGateTokenManagement.read
  • activeGateTokenManagement.write
  • activeGates.read
  • activeGates.write
  • apiTokens.read
  • apiTokens.write
  • auditLogs.read
  • credentialVault.read
  • credentialVault.write
  • entities.read
  • entities.write
  • events.ingest
  • events.read
  • extensionConfigurations.read
  • extensionConfigurations.write
  • extensionEnvironment.read
  • extensionEnvironment.write
  • extensions.read
  • extensions.write
  • geographicRegions.read
  • hub.read
  • hub.write
  • logs.ingest
  • logs.read
  • metrics.ingest
  • metrics.read
  • metrics.write
  • networkZones.read
  • networkZones.write
  • oneAgents.read
  • oneAgents.write
  • openTelemetryTrace.ingest
  • problems.read
  • problems.write
  • releases.read
  • securityProblems.read
  • securityProblems.write
  • settings.read
  • settings.write
  • slo.read
  • slo.write
  • syntheticExecutions.read
  • syntheticExecutions.write
  • syntheticLocations.read
  • syntheticLocations.write
  • tenantTokenRotation.write
  • traces.lookup
name string Имя токена.
id string Идентификатор токена, состоящий из префикса и общедоступной части токена.
owner string Владелец токена.

JSON-модель тела ответа

{
  "lastUsedIpAddress": "34.197.2.44",
  "modifiedDate": "2020-11-12T08:15:30.144Z",
  "additionalMetadata": {
    "dashboardId": "82402bab-7370-4359-924d-88ed13c8919a"
  },
  "expirationDate": "2020-11-12T08:15:30.144Z",
  "personalAccessToken": true,
  "lastUsedDate": "2020-11-12T08:15:30.144Z",
  "creationDate": "2020-11-05T08:15:30.144Z",
  "enabled": true,
  "scopes": [
    "metrics.read"
  ],
  "name": "myToken",
  "id": "dt0c01.ST2EY72KQINMH574WMNVI7YN",
  "owner": "john.smith"
}