POST токен

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

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

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

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

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

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

Параметры

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

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

Объект ApiTokenCreate

Параметры нового токена API.

Элемент	Тип	Описание	Необходимость
personalAccessToken	boolean	Токен представляет собой токен личного доступа ( true) или токен API ( false). Токены личного доступа привязаны к разрешениям их владельца.	по желанию
expirationDate	string	Срок действия токена. Вы можете использовать один из следующих форматов: Отметка времени в миллисекундах UTC. Человекочитаемый формат 2021-01-25T05:57:01.123+01:00. Если часовой пояс не указан, используется UTC. Вы можете использовать пробел вместо T. Секунды и доли секунды не являются обязательными. Относительный таймфрейм, назад. Формат: now-NU/A, где Nколичество времени, Uединица времени и Aвыравнивание. Выравнивание округляет все меньшие значения до ближайшего нуля в прошлом. Например, now-1y/wэто один год назад, выровненный на неделю. Вы также можете указать относительный таймфрейм без выравнивания: now-NU. Поддерживаемые единицы времени для относительного таймфрейма: m: минуты h: часы d: дни w: недели M: месяцы y: годы Если не установлено, срок действия токена никогда не истекает.	по желанию
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-модель тела запроса

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

{
  "personalAccessToken": false,
  "expirationDate": "now+14d",
  "scopes": [
    "metrics.read"
  ],
  "name": "tokenName"
}

Ответ

Коды ответов

Код	Тип	Описание
201	ApiTokenCreated	Успех. Токен создан. Тело ответа содержит секрет токена.
400	ErrorEnvelope	Не удалось. Ввод недействителен.

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

Объект ApiTokenCreated

Недавно созданный токен.

Элемент	Тип	Описание
expirationDate	string	Дата истечения срока действия токена в формате ISO 8601 ( yyyy-MM-dd'T'HH:mm:ss.SSS'Z').
token	string	Секрет токена.
id	string	Идентификатор токена, состоящий из префикса и общедоступной части токена.

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

{
  "expirationDate": "2020-11-12T08:15:30.144Z",
  "token": "dt0c01.ST2EY72KQINMH574WMNVI7YN.G3DFPBEJYMODIDAEX454M7YWBUVEFOWKPRVMWFASS64NFH52PX6BNDVFFM572RZM",
  "id": "dt0c01.ST2EY72KQINMH574WMNVI7YN"
}