Delete Organization O Auth Application By Organization Id Using DELETE

Delete Organization O Auth Application By Organization Id Using DELETE

Delete 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
URI
DELETE
https://{api_host}/csp/gateway/am/api/orgs/{orgId}/oauth-apps
COPY
Path Parameters
string
orgId
Required

Unique identifier (GUID) of the organization.

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

Show optional properties

{
    "clientIdsToDelete": [
        {}
    ]
}
{
    "clientIdsToDelete": [
        "string"
    ]
}
array of string
clientIdsToDelete
Required

Client IDs to delete. Maximum of 15 per request

Authentication
This operation uses the following authentication methods.
Responses
200

Partial Success. Please read the response to see which apps haven't been removed.

Returns PartialSuccessResponseString of type(s) application/json 
{
    "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.


400

Invalid request body

Returns CspErrorResponse of type(s) application/json 
{
    "cspErrorCode": "string",
    "errorCode": "string",
    "message": "string",
    "moduleCode": 0,
    "requestId": "string",
    "statusCode": 0
}
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


401

The user is not authorized to use the API

Returns CspErrorResponse of type(s) application/json 
{
    "cspErrorCode": "string",
    "errorCode": "string",
    "message": "string",
    "moduleCode": 0,
    "requestId": "string",
    "statusCode": 0
}
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 
{
    "cspErrorCode": "string",
    "errorCode": "string",
    "message": "string",
    "moduleCode": 0,
    "requestId": "string",
    "statusCode": 0
}
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

The requested resource could not be found

Returns CspErrorResponse of type(s) application/json 
{
    "cspErrorCode": "string",
    "errorCode": "string",
    "message": "string",
    "moduleCode": 0,
    "requestId": "string",
    "statusCode": 0
}
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 
{
    "cspErrorCode": "string",
    "errorCode": "string",
    "message": "string",
    "moduleCode": 0,
    "requestId": "string",
    "statusCode": 0
}
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 
{
    "cspErrorCode": "string",
    "errorCode": "string",
    "message": "string",
    "moduleCode": 0,
    "requestId": "string",
    "statusCode": 0
}
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


On This Page
Organization Managed Oauth Apps (clients) Operations
POST
Create Organization O Auth Application By Organization Id Using POST
DELETE
Delete Old Client Secret Via Owner Client Rotation By Organization Id And O Auth App Id Using DELETE
DELETE
Delete Organization O Auth Application By Organization Id Using DELETE
GET
Get All Organization O Auth Applications By Orgainzation Id Using GET
GET
Get Organization O Auth Application By Organization Id And Application Id Using GET
POST
Search Organization Clients By Role Names Using POST
POST
Set New Client Secret Via Owner Client Rotation By Organization Id And Application Id Using POST
PATCH
Update Organization O Auth Application By Organization Id And Application Id Using PATCH
PUT
Update Organization O Auth Application Secret By Orgnization Id And Application Id Using PUT