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

Create Auto Entitlement Policy For Organization By Orgnization ID

Description

Create Auto Entitlement Policy for an Organization

Access Policy

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

Request

Request

URL

URL


post
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

CreateAutoEntitlementPolicyRequest of mimetype application/json Required

Request for creating an Auto Entitlement Policy

{
	"name": "string"
}
string as ^[^@]+$
name Required

Policy Name of an Auto Entitlement Policy


string
description Optional

Policy Description of an Auto Entitlement Policy

Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

201 Created returns CreateAutoEntitlementPolicyResponse of type application/json

An Auto Entitlement Policy is created

{
	"id": "string"
}
string
id Optional

The identifier of the Auto Entitlement Policy

Errors

Errors

400

Bad request for creating an Auto Entitlement Policy


401

The user is not authorized to use the API


403

The user is forbidden to use the API


404

The requested resource could not be found


409

An Auto Entitlement Policy already exist with the same name


429

The user has sent too many requests


500

An unexpected error has occurred while processing the request

Code Samples

Code Samples

cURL Command

curl -X POST -H "Content-Type: application/json" -d '{"description":"string","name":"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_owner
x-slo-tier: TIER2


Feedback

Was this page helpful?