GET токен*
Материал из Документация Ключ-АСТРОМ
Получает метаданные токена АктивногоШлюза по его ID.
Запрос создает в качестве полезной нагрузкиapplication/json
формат.
GET | Managed | https://{your-domain}/e/{your-environment-id}/api/v2/activeGateTokens/{activeGateTokenIdentifier}
|
Среда АктивногоШлюза | https://{your-activegate-domain}/e/{your-environment-id}/api/v2/activeGateTokens/{activeGateTokenIdentifier}
|
Аутентификация
Чтобы выполнить этот запрос, вам нужен токен доступа с областью чтения токенов АктивногоШлюза ( activeGateTokenManagement.read
) . Чтобы узнать, как его получить и использовать, см. раздел Токены и аутентификация .
Параметры
Параметр | Тип | Описание | In | Необходимость |
---|---|---|---|---|
activeGateTokenIdentifier | string | Идентификатор токена АктивногоШлюза, состоящий из префикса и общедоступной части токена. | path | требуется |
Ответ
Коды ответов
Код | Тип | Описание |
---|---|---|
200 | ActiveGateToken | Успех. Ответ содержит метаданные маркеров. |
400 | ErrorEnvelope | Не удалось. Ввод недействителен. |
404 | ErrorEnvelope | Не удалось. Запрошенный ресурс не существует. |
Объекты тела ответа
Объект ActiveGateToken
Метаданные токена АктивногоШлюза.
Элемент | Тип | Описание |
---|---|---|
id | string | Идентификатор токена АктивногоШлюза, состоящий из префикса и общедоступной части токена. |
name | string | Имя токена. |
owner | string | Владелец токена. |
creationDate | string | Дата создания токена в формате ISO 8601 ( yyyy-MM-dd'T'HH:mm:ss.SSS'Z' ).
|
expirationDate | string | Дата истечения срока действия токена в формате ISO 8601 ( yyyy-MM-dd'T'HH:mm:ss.SSS'Z' ).
Если не установлено, срок действия токена никогда не истекает. |
lastUsedDate | string | Дата последнего использования токена в формате ISO 8601 ( yyyy-MM-dd'T'HH:mm:ss.SSS'Z' ).
|
seedToken | boolean | Токен является начальным токеном ( true ) или отдельным токеном ( false ).
|
activeGateType | string | Тип АктивногоШлюза, для которого действителен токен.
Элемент может содержать эти значения
|
JSON-модель тела ответа
{
"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"
}
Пример
В этом примере запрос извлекает метаданные для маркера с идентификатором dt0g02.abc123 .
Маркер API передается в заголовке авторизации .
Curl
curl --request GET \
--url https://mySampleEnv.live.ruscomtech.ru//api/v2/activeGateTokens/dt0g02.abc123 \
--header 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'
URL-адрес запроса
https://mySampleEnv.live.ruscomtech.ru//api/v2/activeGateTokens/dt0g02.abc123
Тело ответа
{
"id": "dt0g02.abc123",
"name": "system:installer",
"owner": "max.mustermann@company.com",
"creationDate": "2021-11-22T11:39:29.797Z",
"seedToken": true,
"activeGateType": "ENVIRONMENT"
}
Код ответа
200