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

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

Get the Auto Entitlement Policy by the identifier 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/{policyId}
COPY
Path Parameters
string
orgId
Required

Unique identifier (GUID) of the organization.

string
policyId
Required

The identifier of the Auto Entitlement Policy

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns ExpandedAutoEntitlementPoliciesDto of type(s) application/json 
{
    "lastEditedBy": "string",
    "displayName": "string",
    "id": "string",
    "organizationRoles": [
        {
            "displayName": "string",
            "name": "string",
            "expiresAt": 3609941597,
            "createdBy": "string",
            "lastUpdatedDate": "string",
            "resource": "string",
            "membershipType": "string",
            "createdDate": "string",
            "lastUpdatedBy": "string"
        }
    ],
    "serviceRoles": [
        {
            "serviceRoleNames": [
                "string"
            ],
            "serviceDefinitionId": "string",
            "serviceRoles": [
                {
                    "createdBy": "string",
                    "lastUpdatedBy": "string",
                    "name": "string",
                    "lastUpdatedDate": "string",
                    "expiresAt": 3609941597,
                    "membershipType": "string",
                    "resource": "string",
                    "createdDate": "string"
                }
            ]
        }
    ],
    "description": "string",
    "domains": [
        "string"
    ],
    "customRoles": [
        {
            "createdBy": "string",
            "lastUpdatedBy": "string",
            "name": "string",
            "lastUpdatedDate": "string",
            "expiresAt": 3609941597,
            "membershipType": "string",
            "resource": "string",
            "createdDate": "string"
        }
    ],
    "lastEditedAt": "string"
}
string
lastEditedBy
Optional

The username (email) of the user who edited the Auto Entitlement Policy.

string
displayName
Optional

The display name of the group.

string
id
Optional

Unique identifier of the group.

array of object
organizationRoles
Optional

The organization roles of the group.

array of object
serviceRoles
Optional

The service roles of the group.

string
description
Optional

Description of the Auto Entitlement Policy.

array of string
domains
Optional

Set of domains associated with the Auto Entitlement Policy

array of object
customRoles
Optional

The custom roles of the group.

string
lastEditedAt
Optional

Last Updated time of the Auto Entitlement Policy.


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

Organization with this identifier is not found. | The Auto Entitlement Policy with this identifier is not 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/{policyId}
On This Page
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