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

Update Auto Entitlement Policy By Organization ID And Policy ID

Description

Update an Auto Entitlement Policy Detail of an Organization

Access Policy

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

Request

Request

URL

URL


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

Path Parameters

Path Parameters

string
orgId Required

Unique identifier (GUID) of the organization.

Parameter Serialization Style: simple Explode:false

string
policyId Required

The identifier of the Auto Entitlement Policy

Parameter Serialization Style: simple Explode:false

Request Body

Request Body

UpdateAutoEntitlementPolicyRequest of mimetype application/json Required

Request for Updating the Auto Entitlement Policy

{
	"description": "string"
}
string
description Optional

Policy Description of an Auto Entitlement Policy

Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

200 OK

The Auto Entitlement Policy is updated successfully

Errors

Errors

CspErrorResponse
400

Bad request for updating an Auto Entitlement Policy


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
409

The request could not be processed due to a conflict


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 PATCH -H "Content-Type: application/json" -d '{"description":"string"}' https://{api_host}/csp/gateway/am/api/orgs/{orgId}/auto-entitlement-policies/{policyId}
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?