Получение метаданных токена по запросу

Этот вызов API перечисляет метаданные токена кластера по значению токена. Запрос потребляет и создает полезную нагрузку application/json.

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

Для выполнения этого запроса вам необходимо разрешение API (ClusterTokenManagement), назначенное вашему токену API. Создайте свой токен API с помощью консоли управления кластером (CMC). Чтобы узнать, как его получить и использовать, см. Аутентификация кластера.

Конечная точка

/api/cluster/v2/tokens/lookup

Параметры

Параметр	Тип	Описание	В	Обязательно
body	Token	Тело JSON запроса. Содержит требуемый токен.	body	Да

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

Объект `Token`

Элемент	Тип	Описание	Обязательно
token	string	Токен аутентификации API.	Да

JSON-модель тела запроса

{
  "token": "abcdefjhij1234567890"
}

Ответ

Коды ответа

Код	Тип	Описание
200	TokenMetadata	Успех

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

Объект `TokenMetadata`

Element	Type	Description
id	string	Идентификатор токена.
name	string	Имя токена.
userId	string	Владелец токена.
revoked	boolean	Статус отзыва токена. Отозванные токены отключены.
created	integer	Время создания в виде временной метки unix в миллисекундах.
expires	integer	Время истечения срока действия в виде временной метки unix в миллисекундах.
lastUse	integer	Отметка времени unix в миллисекундах, когда токен использовался в последний раз.
scopes	string[]	Список областей, назначенных маркеру. Элемент может содержать эти значения: `ClusterTokenManagement` `ControlManagement` `DiagnosticExport` `EnvironmentTokenManagement` `ExternalSyntheticIntegration` `Nodekeeper` `ReadSyntheticData` `ServiceProviderAPI` `UnattendedInstall` `activeGateTokenManagement.create` `activeGateTokenManagement.read` `activeGateTokenManagement.write` `apiTokens.read` `apiTokens.write` `settings.read` `settings.write`
personalAccessToken	boolean	Токен является токеном личного доступа `(true)` или токен API `(false)`.

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

{
  "id": "acbed0c4-4ef1-4303-991f-102510a69322",
  "name": "myToken",
  "userId": "john.smith",
  "revoked": true,
  "created": 1554076800000,
  "expires": 1585976400000,
  "lastUse": 1554354000000,
  "personalAccessToken": true,
  "scopes": [
    "DataExport",
    "ReadConfig",
    "WriteConfig"
  ]
}

Пример

В этом примере запрос получает метаданные токена 4e9f128e-04f9-4795-pj319-8b7c-3c14a5e885e4.

Curl

curl -X POST "https://myManaged.cluster.com/api/cluster/v2/tokens/lookup" -H "accept: application/json; charset=utf-8" -H "Content-Type: application/json; charset=utf-8" -d "{ \"token\": \"abcdefjhij1234567890\"}"

URL-адрес запроса

https://myManaged.cluster.com/api/cluster/v2/tokens/lookup

Тело ответа

{
  "id": "4e9f128e-04f9-4795-pj319-8b7c-3c14a5e885e4",
  "name": "myToken",
  "userId": "john.smith",
  "revoked": true,
  "created": 1554076800000,
  "expires": 1585976400000,
  "lastUse": 1554354000000,
  "scopes": [
    "DataExport",
    "ReadConfig",
    "WriteConfig"
  ]
}

Код ответа

200