Create Auto Entitlement Policy For Organization By Orgnization Id Using POST

Create Auto Entitlement Policy For Organization By Orgnization Id Using POST

Create Auto Entitlement Policy for an Organization

Access Policy

Role User Accounts Service Accounts (Client Credentials Applications)
Organization Admin ✔️ ✔️
Organization Owner ✔️ ✔️
Request
URI
POST
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

Request for creating an Auto Entitlement Policy

CreateAutoEntitlementPolicyRequest of type(s) application/json
Required

Show optional properties

{
    "name": "string"
}
{
    "description": "string",
    "name": "string"
}
string
description
Optional

Policy Description of an Auto Entitlement Policy

string As ^[^@]+$
name
Required

Policy Name of an Auto Entitlement Policy

Authentication
This operation uses the following authentication methods.
Responses
201

An Auto Entitlement Policy is created

Returns CreateAutoEntitlementPolicyResponse of type(s) application/json 
{
    "id": "string"
}
string
id
Optional

The identifier of the Auto Entitlement Policy


400

Bad request for creating an Auto Entitlement Policy

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


409

An Auto Entitlement Policy already exist with the same name

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
Auto Entitlement Policy Operations
POST
Add Domains To Auto Entitlement Policy By Organization Id And Policy Id Using POST
POST
Create Auto Entitlement Policy For Organization By Orgnization Id Using POST
GET
Get Auto Entitlement Policies By Organization Id Using GET
GET
Get Auto Entitlement Policy By Organization Id And Policy Id Using GET
DELETE
Remove Auto Entitlement Policies From Organization By Organization Id And Policy Id Using DELETE
DELETE
Remove Domains From Auto Entitlement Policy By Organization Id And Policy Id Using DELETE
PATCH
Update Auto Entitlement Policy By Organization Id And Policy Id Using PATCH