Get Api Token Details Using POST

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

URI

POST

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

COPY

Request Body

The request body for getting API token contents.

GetApiTokenDetailsRequest of type(s) application/json

Required

{
    "tokenValue": "string"
}

string

tokenValue

Required

The value of the API token.

Authentication

This operation uses the following authentication methods.

Bearer

Responses

200

Returns ApiTokenDetailsDto of type(s) application/json

{
    "acct": "string",
    "allowedScopes": {
        "generalScopes": [
            "string"
        ],
        "organizationScopes": {
            "allPermissions": false,
            "allRoles": false,
            "keptInToken": [
                "string"
            ],
            "permissions": [
                {
                    "permissionId": "string",
                    "resources": [
                        "string"
                    ]
                }
            ],
            "roles": [
                {
                    "name": "string",
                    "resource": "string"
                }
            ]
        },
        "servicesScopes": [
            {
                "allPermissions": false,
                "allRoles": false,
                "keptInToken": [
                    "string"
                ],
                "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"
}

string

acct

Optional

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

AllowedScopesDto

allowedScopes

Optional

The allowed general, organization and service scopes of access.

integer As int64 As int64

createdAt

Optional

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

boolean

deactivated

Optional

deactivated

string

deactivatedUpdatedBy

Optional

The user who updated the token's isDeactivated state

integer As int64 As int64

deactivatedUpdatedOn

Optional

The timestamp the token's isDeactivated was last updated (measured in number of seconds since 1/1/1970 UTC).

string

domain

Optional

The identity provider (IdP) domain of the user.

integer As int64 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 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.

array of string

scope

Optional

The scope of access needed for the token

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

404

The requested resource could not be found

Returns CspErrorResponse of type(s) application/json

{
    "cspErrorCode": "string",
    "errorCode": "string",
    "message": "string",
    "moduleCode": 0,
    "requestId": "string",
    "statusCode": 0
}

string

cspErrorCode

Optional

cspErrorCode

string

errorCode

Optional

errorCode

string

message

Optional

message

integer As int32 As int32

moduleCode

Optional

moduleCode

string

requestId

Optional

requestId

integer As int32 As int32

statusCode

Optional

statusCode

409

The request could not be processed due to a conflict

Returns CspErrorResponse of type(s) application/json

{
    "cspErrorCode": "string",
    "errorCode": "string",
    "message": "string",
    "moduleCode": 0,
    "requestId": "string",
    "statusCode": 0
}

string

cspErrorCode

Optional

cspErrorCode

string

errorCode

Optional

errorCode

string

message

Optional

message

integer As int32 As int32

moduleCode

Optional

moduleCode

string

requestId

Optional

requestId

integer As int32 As int32

statusCode

Optional

statusCode

429

The user has sent too many requests

Returns CspErrorResponse of type(s) application/json

{
    "cspErrorCode": "string",
    "errorCode": "string",
    "message": "string",
    "moduleCode": 0,
    "requestId": "string",
    "statusCode": 0
}

string

cspErrorCode

Optional

cspErrorCode

string

errorCode

Optional

errorCode

string

message

Optional

message

integer As int32 As int32

moduleCode

Optional

moduleCode

string

requestId

Optional

requestId

integer As int32 As int32

statusCode

Optional

statusCode

500

An unexpected error has occurred while processing the request

Returns CspErrorResponse of type(s) application/json

{
    "cspErrorCode": "string",
    "errorCode": "string",
    "message": "string",
    "moduleCode": 0,
    "requestId": "string",
    "statusCode": 0
}

string

cspErrorCode

Optional

cspErrorCode

string

errorCode

Optional

errorCode

string

message

Optional

message