ENetrebin: Новая страница: «Получает метаданные токена АктивногоШлюза по его ID. Запрос создает в качестве полезной...»

2022-10-25T13:59:29Z

Новая страница: «Получает метаданные токена АктивногоШлюза по его ID. Запрос создает в качестве полезной...»

Новая страница

Получает метаданные токена АктивногоШлюза по его ID.

Запрос создает в качестве полезной нагрузки<code>application/json</code> формат.
{| class="wikitable"
| rowspan="2" |GET
|Managed
|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/activeGateTokens/{activeGateTokenIdentifier}</nowiki></code>
|-
|Среда АктивногоШлюза
|<code><nowiki>https://{your-activegate-domain}/e/{your-environment-id}/api/v2/activeGateTokens/{activeGateTokenIdentifier}</nowiki></code>
|}

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

== Параметры ==
{| class="wikitable"
!Параметр
!Тип
!Описание
!In
!Необходимость
|-
|activeGateTokenIdentifier
|string
|Идентификатор токена АктивногоШлюза, состоящий из префикса и общедоступной части токена.
|path
|требуется
|}

== Ответ ==

=== Коды ответов ===
{| class="wikitable"
!Код
|Тип
!Описание
|-
|200
|ActiveGateToken
|Успех. Ответ содержит метаданные маркеров.
|-
|400
|ErrorEnvelope
|Не удалось. Ввод недействителен.
|-
|404
|ErrorEnvelope
|Не удалось. Запрошенный ресурс не существует.
|}

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

==== Объект <code>ActiveGateToken</code> ====
Метаданные токена АктивногоШлюза.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|id
|string
|Идентификатор токена АктивногоШлюза, состоящий из префикса и общедоступной части токена.
|-
|name
|string
|Имя токена.
|-
|owner
|string
|Владелец токена.
|-
|creationDate
|string
|Дата создания токена в формате ISO 8601 ( <code>yyyy-MM-dd'T'HH:mm:ss.SSS'Z'</code>).
|-
|expirationDate
|string
|Дата истечения срока действия токена в формате ISO 8601 ( <code>yyyy-MM-dd'T'HH:mm:ss.SSS'Z'</code>).

Если не установлено, срок действия токена никогда не истекает.
|-
|lastUsedDate
|string
|Дата последнего использования токена в формате ISO 8601 ( <code>yyyy-MM-dd'T'HH:mm:ss.SSS'Z'</code>).
|-
|seedToken
|boolean
|Токен является начальным токеном ( <code>true</code>) или отдельным токеном ( <code>false</code>).
|-
|activeGateType
|string
|Тип АктивногоШлюза, для которого действителен токен.

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

* <code>ENVIRONMENT</code>
* <code>CLUSTER</code>
|}

=== JSON-модель тела ответа ===
<code>{
"id": "dt0g02.4KWZO5EF",
"name": "myToken",
"owner": "john.smith",
"creationDate": "2020-11-22T08:15:30.144Z",
"expirationDate": "2020-11-24T08:15:30.144Z",
"lastUsedDate": "2020-11-23T08:15:30.144Z",
"seedToken": false,
"activeGateType": "ENVIRONMENT"
}</code>

== Пример ==
В этом примере запрос извлекает метаданные для маркера с идентификатором dt0g02.abc123 .

Маркер API передается в заголовке авторизации .

==== Curl ====
<code>curl --request GET \
--url <nowiki>https://mySampleEnv.live.ruscomtech.ru//api/v2/activeGateTokens/dt0g02.abc123</nowiki> \
--header 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'</code>

==== URL-адрес запроса ====
<code><nowiki>https://mySampleEnv.live.ruscomtech.ru//api/v2/activeGateTokens/dt0g02.abc123</nowiki></code>

==== Тело ответа ====
<code>{
"id": "dt0g02.abc123",
"name": "system:installer",
"owner": "max.mustermann@company.com",
"creationDate": "2021-11-22T11:39:29.797Z",
"seedToken": true,
"activeGateType": "ENVIRONMENT"
}</code>

==== Код ответа ====
200

GET токен* - История изменений

ENetrebin: Новая страница: «Получает метаданные токена АктивногоШлюза по его ID. Запрос создает в качестве полезной...»