[{"label":"Latest (v1.0)","version":"latest"}]
csp
Delete Organization OAuth Application By Organization ID
DescriptionDelete Organization Managed OAuth Apps.
Pay attention: in case of partial success the caller must read the response to see which apps haven’t been removed
Access Policy
| Role | User Accounts | Service Accounts (Client Credentials Applications) |
|---|---|---|
| Organization Admin | ✔️ | ✔️ |
| Organization Owner | ✔️ | ✔️ |
| Developer | ✔️ | ✔️ |
Request
URLURL
https://{api_host}/csp/gateway/am/api/orgs/{orgId}/oauth-apps
Path Parameters
Path Parameters
string
orgId
Required
Unique identifier (GUID) of the organization.
Parameter Serialization Style:
simple Explode:false
Request Body
Request Body
DeleteClientsRequest
of mimetype application/json
Required
{
"clientIdsToDelete": [
"string"
]
}
array of
string
clientIdsToDelete
Required
Client IDs to delete. Maximum of 15 per request
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK
Returns
PartialSuccessResponseString
of type application/json
Partial Success. Please read the response to see which apps haven’t been removed.
{
"failed": [
"string"
],
"succeeded": [
"string"
]
}
array of
string
failed
Optional
The entities for which the operation failed.
array of
string
succeeded
Optional
The entities for which the operation is successful.
Errors
CspErrorResponse
400
Invalid request body
CspErrorResponse
401
The user is not authorized to use the API
CspErrorResponse
403
The user is forbidden to use the API
CspErrorResponse
404
The requested resource could not be found
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 DELETE -H "Content-Type: application/json" -d '{"clientIdsToDelete":["string"]}' https://{api_host}/csp/gateway/am/api/orgs/{orgId}/oauth-apps
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-required-roles: org_admin,org_owner,developer
x-slo-tier: TIER2
[{"label":"Latest (v1.0)","version":"latest"}]
csp
