Deactivate Organization Refresh Tokens Using POST

Deactivates the tokens provided. Max 15 tokens can be deactivated in a request. Note: Partial success, please read response which tokenIds could not be deactivated

Access Policy

Role	User Accounts	Service Accounts (Client Credentials Applications)
Organization Owner	✔️	❌

Request

URI

POST

https://{api_host}/csp/gateway/am/api/orgs/{orgId}/tokens/deactivate

COPY

Path Parameters

string

orgId

Required

Unique identifier (GUID) of the organization.

Request Body

ChangeApiTokensStatusRequest of type(s) application/json

Required

"ChangeApiTokensStatusRequest Object"

array of string

ids

Required

Constraints: minItems: 1 maxItems: 15

Token Ids

Authentication

This operation uses the following authentication methods.

Bearer

Responses

200

Partial Success, please read response which tokenIds could not be deactivated

Returns ChangeApiTokensStatusResponse of type(s) application/json

{
    "failures": [
        {
            "id": "string",
            "message": "string"
        }
    ],
    "successes": [
        "string"
    ]
}

array of object

failures

Optional

Token Ids failed to update

array of string

successes

Optional

List of successfully updated token Ids

401

The user is not authorized to use the API

Returns CspErrorResponse of type(s) application/json

"CspErrorResponse Object"

string

cspErrorCode

Optional

cspErrorCode

string

message

Optional

message

string

errorCode

Optional

errorCode

string

requestId

Optional

requestId

integer As int32 As int32

moduleCode

Optional

moduleCode

integer As int32 As int32

statusCode

Optional

statusCode

403

The user is forbidden to use the API

Returns CspErrorResponse of type(s) application/json

"CspErrorResponse Object"

string

cspErrorCode

Optional

cspErrorCode

string

message

Optional

message

string

errorCode

Optional

errorCode

string

requestId

Optional

requestId

integer As int32 As int32

moduleCode

Optional

moduleCode

integer As int32 As int32

statusCode

Optional

statusCode

404

Organization with this identifier is not found.

Returns CspErrorResponse of type(s) application/json

"CspErrorResponse Object"

string

cspErrorCode

Optional

cspErrorCode

string

message

Optional

message

string

errorCode

Optional

errorCode

string

requestId

Optional

requestId

integer As int32 As int32

moduleCode

Optional

moduleCode

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

"CspErrorResponse Object"

string

cspErrorCode

Optional

cspErrorCode

string

message

Optional

message

string

errorCode

Optional

errorCode

string

requestId

Optional

requestId

integer As int32 As int32

moduleCode

Optional

moduleCode

integer As int32 As int32

statusCode

Optional

statusCode

429

The user has sent too many requests

Returns CspErrorResponse of type(s) application/json

"CspErrorResponse Object"

string

cspErrorCode

Optional

cspErrorCode

string

message

Optional

message

string

errorCode

Optional

errorCode

string

requestId

Optional

requestId

integer As int32 As int32

moduleCode

Optional

moduleCode

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

"CspErrorResponse Object"

string

cspErrorCode

Optional

cspErrorCode

string

message

Optional

message

string

errorCode

Optional

errorCode

string

requestId

Optional

requestId

integer As int32 As int32

moduleCode

Optional

moduleCode

integer As int32 As int32

statusCode

Optional

statusCode

Code Samples

COPY

                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '[{}]' https://{api_host}/csp/gateway/am/api/orgs/{orgId}/tokens/deactivate

Deprecated

On This Page

Description

Request

Path Parameters

Request Body

Authentication

Response

200 Response Body

Errors

Organization Operations

GET