Просмотр кода страницы GET все токены

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

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

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

Запрос создает в качестве полезной нагрузки <code>application/json</code> формат.
{| class="wikitable"
| rowspan="2" |GET
|Manged
|<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>
|}

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

== Параметры ==
{| class="wikitable"
!Параметр
!Тип
!Описание
!In
!Необходимость
|-
|nextPageKey
|string
|Курсор для следующей страницы результатов. Вы можете найти его в поле nextPageKey предыдущего ответа.

Первая страница всегда возвращается, если вы не укажете параметр запроса nextPageKey .

Когда nextPageKey настроен на получение последующих страниц, вы должны опустить все остальные параметры запроса.
|query
|по желанию
|-
|pageSize
|integer
|Количество токенов API в полезной нагрузке одного ответа.

Максимально допустимый размер страницы — 10000, а минимально допустимый размер страницы — 100.

Если не установлено, используется 200.
|query
|по желанию
|-
|apiTokenSelector
|string
|Фильтрует полученные наборы токенов. В ответ включаются только токены, соответствующие заданным критериям.

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

* Владелец: <code>owner("value")</code>. Пользователь, которому принадлежит токен. Деликатный случай.
* Токен личного доступа: <code>personalAccessToken(false)</code>. Установите, <code>true</code>чтобы включить только токены личного доступа, или <code>false</code>чтобы включить только токены API.
* Объем токена: <code>scope("scope1","scope2")</code>. Если указано несколько значений, применяется логика ИЛИ .

Чтобы задать несколько критериев, разделите их запятыми ( <code>,</code>). В ответ включаются только результаты, соответствующие всем критериям.
|query
|по желанию
|-
|fields
|string
|Указывает поля, которые должны быть включены в ответ.

По умолчанию включены следующие поля:

* <code>id</code>
* <code>name</code>
* <code>enabled</code>
* <code>owner</code>
* <code>creationDate</code>

Чтобы удалить поля из ответа, укажите их с помощью оператора минус ( -) в виде списка, разделенного запятыми (например, <code>-creationDate,-owner</code>).

Вы можете включить дополнительные поля:

* <code>personalAccessToken</code>
* <code>expirationDate</code>
* <code>lastUsedDate</code>
* <code>lastUsedIpAddress</code>
* <code>modifiedDate</code>
* <code>scopes</code>
* <code>additionalMetadata</code>

Чтобы добавить поля в ответ, укажите их с помощью оператора плюс (+) в виде списка, разделенного запятыми (например, <code>+expirationDate,+scopes</code>). Вы можете комбинировать добавление и удаление полей (например, <code>+scopes,-creationDate</code>).

Кроме того, вы можете определить желаемый набор полей в ответе. Укажите обязательные поля в виде списка, разделенного запятыми, без операторов (например, <code>creationDate,expirationDate,owner</code>). Идентификатор всегда включается в ответ.

Строка полей должна быть закодирована в URL.
|query
|по желанию
|-
|from
|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>: годы
|query
|по желанию
|-
|to
|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>: годы

Если не установлено, используется текущая метка времени.
|query
|по желанию
|-
|sort
|string
|Порядок сортировки списка токенов.

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

* <code>name</code>: имя токена ( <code>+</code>a...z или <code>-</code>z...a)
* <code>lastUsedDate</code>последний использованный ( <code>+</code>сначала никогда не использовавшиеся токены, сначала <code>-</code>самые недавно использовавшиеся токены)
* <code>creationDate</code>( Сначала самые <code>+</code>старые токены, сначала <code>-</code>самые новые)
* <code>expirationDate</code>( <code>+</code>токены, срок действия которых скоро истекает, сначала <code>-</code>неограниченное количество токенов)
* <code>modifiedDate</code>последние измененные ( <code>+</code>сначала никогда не изменявшиеся токены, сначала <code>-</code>самые недавно измененные токены)

Если префикс не установлен, используется +.

Если не задано, токены сортируются по дате создания, начиная с самых новых.
|query
|по желанию
|}

== Ответ ==

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

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

==== Объект <code>ApiTokenList</code> ====
Список токенов API.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|apiTokens
|ApiToken[]
|Список токенов API.
|-
|nextPageKey
|string
|Курсор для следующей страницы результатов. Имеет значение <code>null</code>на последней странице.

Используйте его в параметре запроса nextPageKey для получения последующих страниц результата.
|-
|pageSize
|integer
|Количество записей на странице.
|-
|totalCount
|integer
|Общее количество записей в результате.
|}

==== Объект <code>ApiToken</code> ====
Метаданные токена API.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|lastUsedIpAddress
|string
|Последний использованный токеном IP-адрес.
|-
|modifiedDate
|string
|Дата последнего изменения токена в формате ISO 8601 ( <code>yyyy-MM-dd'T'HH:mm:ss.SSS'Z'</code>). Обновление областей действия или имени считается модификацией, а включение или отключение токена — нет.
|-
|additionalMetadata
|object
|Содержит дополнительные свойства для определенных типов токенов. Примеры:

* <code>dashboardId</code>Свойство для токенов совместного использования панели мониторинга .
* <code>reportId</code>Свойство для токенов общего доступа к отчетам
|-
|expirationDate
|string
|Срок действия токена в формате ISO 8601 ( <code>yyyy-MM-dd'T'HH:mm:ss.SSS'Z'</code>).

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

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

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

=== JSON-модель тела ответа ===
 <code>{
   "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"
     }
   }
 }</code>