[{"label":"Latest (v1.0)","version":"latest"}]
csp

Remove Auto Entitlement Policies From Organization By Organization ID And Policy ID

Description

Remove the Auto Entitlement Policy from the organization.

Access Policy

Role User Accounts Service Accounts (Client Credentials Applications)
Organization Admin ✔️ ✔️
Organization Owner ✔️ ✔️

Request

Request

URL

URL


delete
https://{api_host}/csp/gateway/am/api/orgs/{orgId}/auto-entitlement-policies
Copy

Path Parameters

Path Parameters

string
orgId Required

Unique identifier (GUID) of the organization.

Parameter Serialization Style: simple Explode:false

Request Body

Request Body

DeleteAutoEntitlementPolicyRequest of mimetype application/json Required
{
	"ids": [
		"string"
	]
}
array of string
ids Required

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

Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK

Returns RemoveAutoEntitlementPoliciesResponseString of type application/json
{
	"failed": [
		"string"
	],
	"failures": [
		{
			"errorCode": "string",
			"id": "string",
			"message": "string"
		}
	],
	"succeeded": [
		"string"
	]
}
array of string
failed Optional

The entities for which the operation failed.


failures Optional

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


array of string
succeeded Optional

The entities for which the operation is successful.

Errors

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. | The Auto Entitlement Policy with this identifier is not found.


CspErrorResponse
429

The user has sent too many requests


CspErrorResponse
500

An unexpected error has occurred while processing the request

Code Samples

Code Samples

cURL Command

curl -X DELETE -H "Content-Type: application/json" -d '{"ids":["string"]}' https://{api_host}/csp/gateway/am/api/orgs/{orgId}/auto-entitlement-policies
Vendor Extensions

Vendor Extensions

This operation contains the following vendor extensions defined in the spec:
x-required-roles: org_admin,org_owner
x-slo-tier: TIER2


Feedback

Was this page helpful?