[{"label":"Latest (v1.0)","version":"latest"}]
csp
Deactivate Organization Refresh Tokens With API Token Path
DescriptionDeactivates 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
URLURL
https://{api_host}/csp/gateway/am/api/orgs/{orgId}/api-tokens/deactivate
Path Parameters
Path Parameters
string
orgId
Required
Unique identifier (GUID) of the organization.
Parameter Serialization Style:
SIMPLE Explode:false
Request Body
Request Body
ChangeApiTokensStatusRequest
of mimetype application/json
Required
{
"ids": [
"string"
]
}
array of
string
ids
Required
Token Ids
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK
Returns
ChangeApiTokensStatusResponse
of type application/json
Partial Success, please read response which tokenIds could not be deactivated
{
"failures": [
{
"id": "string",
"message": "string"
}
],
"successes": [
"string"
]
}
array of
string
successes
Optional
List of successfully updated token Ids
Errors
CspErrorResponse
401
The user is not authorized to use the API
CspErrorResponse
403
The user is forbidden to use the API
CspErrorResponse
404
Organization with this identifier is not found.
CspErrorResponse
409
The request could not be processed due to a conflict
CspErrorResponse
429
The user has sent too many requests
CspErrorResponse
500
An unexpected error has occurred while processing the request
Code Samples
cURL Command
curl -X POST -H "Content-Type: application/json" -d '{"ids":["string"]}' https://{api_host}/csp/gateway/am/api/orgs/{orgId}/api-tokens/deactivate
[{"label":"Latest (v1.0)","version":"latest"}]
csp
On This Page
Organization Operations
post
post
delete
