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

Add Domains To Auto Entitlement Policy By Organization ID And Policy ID

Description

Add set of domains to the Auto Entitlement Policy of 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/{policyId}/domains
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

AddDomainsToAutoEntitlementPolicy of mimetype application/json Required

Domains to be added into the Auto Entitlement Policy

{
	"domains": [
		"string"
	]
}
array of string
domains Required

Set of domains associated with the Auto Entitlement Policy

Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

201 Created returns AddDomainsToAutoEntitlementPolicyResponse of type application/json

Domains are successfully added to the Auto Entitlement Policy

{
	"failed": [
		"string"
	],
	"succeeded": [
		"string"
	]
}
array of string
failed Optional

Domains which were not added to the Auto Entitlement Policy


array of string
succeeded Optional

Domains which were successfully added into the Auto Entitlement Policy

Errors

Errors

400

Domains are not linked with Identity Provider


401

The user is not authorized to use the API


403

The user is forbidden to use the API


404

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


409

The request could not be processed due to a conflict


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 '{"domains":["string"]}' https://{api_host}/csp/gateway/am/api/orgs/{orgId}/auto-entitlement-policies/{policyId}/domains
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?