Revoke Consent Using DELETE
Revoke consent before it expires
Access Policy
| Role | User Accounts | Service Accounts (Client Credentials Applications) |
|---|---|---|
| Organization Admin | ✔️ | ❌ |
| Organization Owner | ✔️ | ❌ |
Request
URI
DELETE
https://{api_host}/csp/gateway/am/api/orgs/{orgId}/consents/{consentId}
COPY
Path Parameters
string
orgId
Required
Unique identifier (GUID) of the organization.
string
consentId
Required
The unique identifier of the CONSENT.
Responses
200
Consent is revoked successfully.
Operation doesn't return any data structure
401
The user is not authorized to use the API
Returns CspErrorResponse of type(s) application/json
{
"cspErrorCode": "string",
"message": "string",
"errorCode": "string",
"requestId": "string",
"moduleCode": 0,
"statusCode": 0
}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
Consent is not present.
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 DELETE -H 'Authorization: <value>' https://{api_host}/csp/gateway/am/api/orgs/{orgId}/consents/{consentId}