GET все токены

Список всех токенов API, доступных в вашей среде.

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

1. Укажите количество результатов на странице в параметре запроса pageSize .
2. Затем используйте курсор из поля nextPageKey предыдущего ответа в параметре запроса nextPageKey для получения последующих страниц.

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

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

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

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

Параметры

Параметр	Тип	Описание	In	Необходимость
nextPageKey	string	Курсор для следующей страницы результатов. Вы можете найти его в поле nextPageKey предыдущего ответа. Первая страница всегда возвращается, если вы не укажете параметр запроса nextPageKey . Когда nextPageKey настроен на получение последующих страниц, вы должны опустить все остальные параметры запроса.	query	по желанию
pageSize	integer	Количество токенов API в полезной нагрузке одного ответа. Максимально допустимый размер страницы — 10000, а минимально допустимый размер страницы — 100. Если не установлено, используется 200.	query	по желанию
apiTokenSelector	string	Фильтрует полученные наборы токенов. В ответ включаются только токены, соответствующие заданным критериям. Вы можете установить один или несколько из следующих критериев: Владелец: owner("value"). Пользователь, которому принадлежит токен. Деликатный случай. Токен личного доступа: personalAccessToken(false). Установите, trueчтобы включить только токены личного доступа, или falseчтобы включить только токены API. Объем токена: scope("scope1","scope2"). Если указано несколько значений, применяется логика ИЛИ . Чтобы задать несколько критериев, разделите их запятыми ( ,). В ответ включаются только результаты, соответствующие всем критериям.	query	по желанию
fields	string	Указывает поля, которые должны быть включены в ответ. По умолчанию включены следующие поля: id name enabled owner creationDate Чтобы удалить поля из ответа, укажите их с помощью оператора минус ( -) в виде списка, разделенного запятыми (например, -creationDate,-owner). Вы можете включить дополнительные поля: personalAccessToken expirationDate lastUsedDate lastUsedIpAddress modifiedDate scopes additionalMetadata Чтобы добавить поля в ответ, укажите их с помощью оператора плюс (+) в виде списка, разделенного запятыми (например, +expirationDate,+scopes). Вы можете комбинировать добавление и удаление полей (например, +scopes,-creationDate). Кроме того, вы можете определить желаемый набор полей в ответе. Укажите обязательные поля в виде списка, разделенного запятыми, без операторов (например, creationDate,expirationDate,owner). Идентификатор всегда включается в ответ. Строка полей должна быть закодирована в URL.	query	по желанию
from	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: годы	query	по желанию
to	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: годы Если не установлено, используется текущая метка времени.	query	по желанию
sort	string	Порядок сортировки списка токенов. Вы можете сортировать по следующим свойствам с префиксом знака для порядка сортировки: name: имя токена ( +a...z или -z...a) lastUsedDateпоследний использованный ( +сначала никогда не использовавшиеся токены, сначала -самые недавно использовавшиеся токены) creationDate( Сначала самые +старые токены, сначала -самые новые) expirationDate( +токены, срок действия которых скоро истекает, сначала -неограниченное количество токенов) modifiedDateпоследние измененные ( +сначала никогда не изменявшиеся токены, сначала -самые недавно измененные токены) Если префикс не установлен, используется +. Если не задано, токены сортируются по дате создания, начиная с самых новых.	query	по желанию

Ответ

Коды ответов

Код	Тип	Описание
200	ApiTokenList	Успех
400	ErrorEnvelope	Не удалось. Ввод недействителен.

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

Объект ApiTokenList

Список токенов API.

Элемент	Тип	Описание
apiTokens	ApiToken[]	Список токенов API.
nextPageKey	string	Курсор для следующей страницы результатов. Имеет значение nullна последней странице. Используйте его в параметре запроса nextPageKey для получения последующих страниц результата.
pageSize	integer	Количество записей на странице.
totalCount	integer	Общее количество записей в результате.

Объект 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-модель тела ответа

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