Deactivate Organization Refresh Tokens With Api Token Path Using POST

Deactivate Organization Refresh Tokens With Api Token Path 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}/api-tokens/deactivate
COPY
Path Parameters
string
orgId
Required

Unique identifier (GUID) of the organization.

Request Body
ChangeApiTokensStatusRequest of type(s) application/json
Required

Show optional properties

{
    "ids": [
        {}
    ]
}
{
    "ids": [
        "string"
    ]
}
array of string
ids
Required
Constraints: minItems: 1 maxItems: 15

Token Ids

Authentication
This operation uses the following authentication methods.
Responses
200

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

Returns ChangeApiTokensStatusResponse of type(s) application/json 
"ChangeApiTokensStatusResponse Object"
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
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


403

The user is forbidden to use the API

Returns CspErrorResponse of type(s) application/json 
"CspErrorResponse Object"
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


404

Organization with this identifier is not found.

Returns CspErrorResponse of type(s) application/json 
"CspErrorResponse Object"
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 
"CspErrorResponse Object"
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 
"CspErrorResponse Object"
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 
"CspErrorResponse Object"
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


Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"ids":["string"]}' https://{api_host}/csp/gateway/am/api/orgs/{orgId}/api-tokens/deactivate
On This Page
Organization Operations
GET
Get Organization By Id Using GET
PATCH
Update Organization By Organization Id Using PATCH
POST
Activate Organization Refresh Tokens With Api Token Path Using POST
POST
Deactivate Organization Refresh Tokens With Api Token Path Using POST
DELETE
Remove Clients From Organization By Organization Id Using DELETE
GET
Get Organization Clients By Organization Id Using GET
POST
Assign Roles To Clients On Organization Using POST
GET
Get Groups In Organizations By Organization Id And Group Search Term Using GET
DELETE
Delete Organization Idp Registration Using DELETE
GET
Get Org Linked Idp Details Using GET
POST
Link Org To Idp Using POST
GET
Get Organization Invitations By Organization Id Using GET
POST
Invite Users Using POST
DELETE
Revoke User Invitation By Organization Id And User Invitation Id Using DELETE
GET
Get User Invitation By Organization Id And User Invitation Id Using GET
GET
Get Organization Roles By Organization Id Using GET
GET
Get Sub Organizations By Organization Id Using GET
POST
Activate Organization Refresh Tokens Using POST
Deprecated
POST
Deactivate Organization Refresh Tokens Using POST
Deprecated
GET
Get Users In Organization By Organization Id And User Search Term Using GET
Deprecated
POST
Search Organization Users By Organization Id And Roles Search Term Using POST
DELETE
Remove Users From Organization By Organization Id Using DELETE
GET
Get Organization Users By Organization Id Using GET