Get Auto Entitlement Policies By Organization Id Using GET

List the Auto Entitlement Policies for an Organization

Access Policy

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

Request

URI

GET

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

COPY

Path Parameters

string

orgId

Required

Unique identifier (GUID) of the organization.

Query Parameters

integer

pageStart

Optional

Constraints: minimum: 1 default: 1

Specifies the index that the set of results will begin with

integer

pageLimit

Optional

Constraints: minimum: 1 maximum: 200 default: 200

Specifies the maximum results per page for every call.

Authentication

This operation uses the following authentication methods.

Bearer

Responses

200

Successfully fetched list of Auto Entitlement Policies for the Organization

Returns PagedResponseAutoEntitlementPoliciesDto of type(s) application/json

{
    "prevLink": "/csp/serviceName/ResourceName?pageStart=30&pageLimit=15",
    "results": [
        {
            "lastEditedBy": "string",
            "displayName": "string",
            "id": "string",
            "domains": [
                "string"
            ],
            "lastEditedAt": "string",
            "description": "string"
        }
    ],
    "totalResults": 2000,
    "nextLink": "/csp/serviceName/ResourceName?pageStart=60&pageLimit=15"
}

string

prevLink

Optional

Relative path to previous page if exists. Not returned for POST requests.

array of object

results

Optional

Partial list of returned results.

integer As int32 As int32

totalResults

Optional

Total number of results if available.

string

nextLink

Optional

Relative path to next page if exists. Not returned for POST requests.

400

Bad request for listing the Auto Entitlement Policies for the Organization

Returns CspErrorResponse of type(s) application/json

"CspErrorResponse Object"

string

cspErrorCode

Optional

cspErrorCode

string

message

Optional

message

string

errorCode

Optional

errorCode

string

requestId

Optional

requestId

integer As int32 As int32

moduleCode

Optional

moduleCode

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

"CspErrorResponse Object"

string

cspErrorCode

Optional

cspErrorCode

string

message

Optional

message

string

errorCode

Optional

errorCode

string

requestId

Optional

requestId

integer As int32 As int32

moduleCode

Optional

moduleCode

integer As int32 As int32

statusCode

Optional

statusCode

403

The user is forbidden to use the API

Returns CspErrorResponse of type(s) application/json

"CspErrorResponse Object"

string

cspErrorCode

Optional

cspErrorCode

string

message

Optional

message

string

errorCode

Optional

errorCode

string

requestId

Optional

requestId

integer As int32 As int32

moduleCode

Optional

moduleCode

integer As int32 As int32

statusCode

Optional

statusCode

404

The requested resource could not be found

Returns CspErrorResponse of type(s) application/json

"CspErrorResponse Object"

string

cspErrorCode

Optional

cspErrorCode

string

message

Optional

message

string

errorCode

Optional

errorCode

string

requestId

Optional

requestId

integer As int32 As int32

moduleCode

Optional

moduleCode

integer As int32 As int32

statusCode

Optional

statusCode

429

The user has sent too many requests

Returns CspErrorResponse of type(s) application/json

"CspErrorResponse Object"

string

cspErrorCode

Optional

cspErrorCode

string

message

Optional

message

string

errorCode

Optional

errorCode

string

requestId

Optional

requestId

integer As int32 As int32

moduleCode

Optional

moduleCode

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

"CspErrorResponse Object"

string

cspErrorCode

Optional

cspErrorCode

string

message

Optional

message

string

errorCode

Optional

errorCode

string

requestId

Optional

requestId

integer As int32 As int32

moduleCode

Optional

moduleCode

integer As int32 As int32

statusCode

Optional

statusCode

Code Samples

COPY

                    curl -H 'Authorization: <value>' https://{api_host}/csp/gateway/am/api/orgs/{orgId}/auto-entitlement-policies

On This Page

Description

Request

Path Parameters

Query Parameters

Authentication

Response

200 Response Body

Errors

Auto Entitlement Policy Operations

POST

Create Auto Entitlement Policy For Organization By Orgnization Id Using POST

DELETE

Remove Auto Entitlement Policies From Organization By Organization Id And Policy Id Using DELETE

GET

Get Auto Entitlement Policies By Organization Id Using GET

DELETE

Remove Domains From Auto Entitlement Policy By Organization Id And Policy Id Using DELETE

POST

Add Domains To Auto Entitlement Policy By Organization Id And Policy Id Using POST

PATCH

Update Auto Entitlement Policy By Organization Id And Policy Id Using PATCH

GET

Get Auto Entitlement Policy By Organization Id And Policy Id Using GET