Get Api Token | VCF Operations API

Get Api Token

Get API Token details by ID

Retrieves complete details of a specific API Token by token ID.

Request

URI

GET

https://{api_host}/suite-api/api/fleet-management/iam/ssorealms/{ssoRealmId}/api-tokens/{apiTokenId}

COPY

Path Parameters

string

ssoRealmId

Required

SSO Realm identifier

string

apiTokenId

Required

API Token identifier

Authentication

This operation uses the following authentication methods.

Token-based-authorization

Responses

200

API Token details

Returns ApiToken of type(s) application/json

"{\n  \"id\" : \"167ab548-2b73-4eee-aeac-80752133b0c3\",\n  \"apiClientId\" : \"api-client-id\",\n  \"tokenName\" : \"Automation API Token\",\n  \"tokenDescription\" : \"Used for generic automation purposes\",\n  \"apiTokenTtl\" : 259200,\n  \"accessTokenTtl\" : 480,\n  \"tokenType\" : \"API_CLIENT\",\n  \"tokenLastChars\" : \"VWXYZ\",\n  \"principalName\" : \"api-client-id\",\n  \"creationDate\" : 1748026688158,\n  \"expirationDate\" : 1750526688158,\n  \"lastUsedDate\" : 1748026688158,\n  \"tokenStatus\" : \"ACTIVE\",\n  \"tokenEndpointUrl\" : \"https://host.com/acs/t/CUSTOMER/token\",\n  \"oidcIssuerUrl\" : \"https://host.com/acs/t/CUSTOMER\"\n}"

integer As int32 As int32

accessTokenTtl

Optional

Time-To-Live lifespan in minutes of the access tokens that are generated from this API token

string

apiClientId

Optional

Client ID of the API client with which this API token is associated

integer As int32 As int32

apiTokenTtl

Optional

Time-To-Live lifespan in minutes of the API token

integer As int64 As int64

creationDate

Optional

The date on which the API token was created

integer As int64 As int64

expirationDate

Optional

The date on which the API token expires

string As uuid As uuid

Optional

Unique ID for API token in identity broker

integer As int64 As int64

lastUsedDate

Optional

The date on which the API token was last exchanged for a bearer token

string

oidcIssuerUrl

Optional

The OIDC issuer URL

string

principalName

Optional

The name of the principal for which this token was generated: UPN for users and client ID for API clients

string

principalStatus

Optional

Principal active / inactive status

Possible values are : ACTIVE, INACTIVE, UNKNOWN,

string

token

Optional

Full API token string that callers can use to obtain bearer access tokens

string

tokenDescription

Optional

Optional description of the API token

string

tokenEndpointUrl

Optional

The token endpoint URL

string

tokenLastChars

Optional

Sub string containing the last few characters of the full token string

string

tokenName

Required

User-friendly display name of the API token

string

tokenStatus

Optional

API token active / expired status

Possible values are : ACTIVE, EXPIRED, UNKNOWN,

string

tokenType

Optional

API token client / user type

Possible values are : API_CLIENT, USER, UNKNOWN,

Code Samples

COPY

                    curl -H 'Authorization: <value>' https://{api_host}/suite-api/api/fleet-management/iam/ssorealms/{ssoRealmId}/api-tokens/{apiTokenId}

On This Page

Description

Request

Path Parameters

Authentication

Response

200 Response Body

Iam Apis Operations

GET

Get Eligible Components

DELETE

Delete Iam Component Auth Source