[{"label":"Latest (v1.0)","version":"latest"}]
csp

Get API Token Details

Description

Get details of an unexpired org scoped API-token that was previously obtained via CSP web console.

Access Policy

Role User Accounts Service Accounts (Client Credentials Applications)
Anonymous ✔️ ✔️

Request

Request

URL

URL


post
https://{api_host}/csp/gateway/am/api/auth/api-tokens/details
Copy

Request Body

Request Body

GetApiTokenDetailsRequest of mimetype application/json Required

The request body for getting API token contents.

{
	"tokenValue": "string"
}
string
tokenValue Required

The value of the API token.

Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK returns ApiTokenDetailsDto of type application/json
{
	"acct": "string",
	"createdAt": 0,
	"domain": "string",
	"expiresAt": 0,
	"idpId": "string",
	"lastUsedAt": 0,
	"orgId": "string",
	"token": "string",
	"tokenId": "string",
	"tokenName": "string",
	"userId": "string",
	"username": "string"
}
string
acct Optional

The identifier of the user, configured to log in to the Identity provider.


integer as int64
createdAt Optional

The timestamp the token was created at (measured in number of seconds since 1/1/1970 UTC).


string
domain Optional

The identity provider (IdP) domain of the user.


integer as int64
expiresAt Optional

The timestamp the token expires at (measured in number of seconds since 1/1/1970 UTC).


string
idpId Optional

The identifier of the identity provider.


integer as int64
lastUsedAt Optional

The timestamp the token was last used (measured in number of seconds since 1/1/1970 UTC).


string
orgId Optional

Unique identifier (GUID) of the organization.


string
token Optional

The value of the API token.


string
tokenId Optional

The unique identifier of the API token.


string
tokenName Optional

The name of the API token.


string
userId Optional

The unique identifier of the user, on behalf of which the token was issued.


string
username Optional

Deprecated. The username of the user to whom the api token belongs

Errors

Errors

404

The requested resource could not be found


409

The request could not be processed due to a conflict


429

The user has sent too many requests


500

An unexpected error has occurred while processing the request

Code Samples

Code Samples

cURL Command

curl -X POST -H "Content-Type: application/json" -d '{"tokenValue":"string"}' https://{api_host}/csp/gateway/am/api/auth/api-tokens/details
Vendor Extensions

Vendor Extensions

This operation contains the following vendor extensions defined in the spec:
x-required-roles: ""
x-slo-tier: TIER2


Feedback

Was this page helpful?