Get API Token Details
DescriptionGet 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
URLURL
Request Body
The request body for getting API token contents.
{
"tokenValue": "string"
}
The value of the API token.
Authentication
Response
Response BodyResponse Body
200 OK
{
"acct": "string",
"allowedScopes": {
"generalScopes": [
"string"
],
"organizationScopes": {
"allPermissions": false,
"allRoles": false,
"keptInToken": [
"ROLES"
],
"permissions": [
{
"permissionId": "string",
"resources": [
"string"
]
}
],
"roles": [
{
"name": "string",
"resource": "string"
}
]
},
"servicesScopes": [
{
"allPermissions": false,
"allRoles": false,
"keptInToken": [
"ROLES"
],
"permissions": [
{
"permissionId": "string",
"resources": [
"string"
]
}
],
"roles": [
{
"name": "string",
"resource": "string"
}
],
"serviceDefinitionId": "string"
}
]
},
"createdAt": 0,
"deactivated": false,
"deactivatedUpdatedBy": "string",
"deactivatedUpdatedOn": 0,
"domain": "string",
"expiresAt": 0,
"idpId": "string",
"lastUsedAt": 0,
"orgId": "string",
"scope": [
"string"
],
"token": "string",
"tokenId": "string",
"tokenName": "string",
"userId": "string",
"username": "string"
}
The identifier of the user, configured to log in to the Identity provider.
The allowed general, organization and service scopes of access.
The timestamp the token was created at (measured in number of seconds since 1/1/1970 UTC).
The user who updated the token’s isDeactivated state
The timestamp the token’s isDeactivated was last updated (measured in number of seconds since 1/1/1970 UTC).
The identity provider (IdP) domain of the user.
The timestamp the token expires at (measured in number of seconds since 1/1/1970 UTC).
The identifier of the identity provider.
The timestamp the token was last used (measured in number of seconds since 1/1/1970 UTC).
Unique identifier (GUID) of the organization.
The scope of access needed for the token
The value of the API token.
The unique identifier of the API token.
The name of the API token.
The unique identifier of the user, on behalf of which the token was issued.
Deprecated. The username of the user to whom the api token belongs
Errors
The requested resource could not be found
The request could not be processed due to a conflict
The user has sent too many requests
An unexpected error has occurred while processing the request
