Remove Auto Entitlement Policies From Organization By Organization Id And Policy Id Using DELETE

Remove the Auto Entitlement Policy from the organization.

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}/auto-entitlement-policies

COPY

Path Parameters

string

orgId

Required

Unique identifier (GUID) of the organization.

Request Body

DeleteAutoEntitlementPolicyRequest of type(s) application/json

Required

"DeleteAutoEntitlementPolicyRequest Object"

array of string

ids

Required

Constraints: minItems: 0 maxItems: 20

Identifiers of the members that will be removed from the organization.

Authentication

This operation uses the following authentication methods.

Bearer

Responses

200

Returns RemoveAutoEntitlementPoliciesResponseString of type(s) application/json

{
    "failed": [
        "string"
    ],
    "succeeded": [
        "string"
    ],
    "failures": [
        {
            "message": "string",
            "id": "string",
            "errorCode": "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.

array of object

failures

Optional

The Auto Entitlement policy identifiers for which the delete operation failed along with the reason of failure.

401

The user is not authorized 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

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

Organization with this identifier is not found. | The Auto Entitlement Policy with this identifier is not found.

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>' -H 'Content-Type: application/json' -d '[{}]' https://{api_host}/csp/gateway/am/api/orgs/{orgId}/auto-entitlement-policies

On This Page

Description

Request

Path Parameters

Request Body

Authentication

Response

200 Response Body

Errors

Auto Entitlement Policy Operations

POST

Create Auto Entitlement Policy For Organization By Orgnization Id Using POST