[{"label":"Latest (v1.0)","version":"latest"}]
csp
Get Auto Entitlement Policy By Organization ID And Policy ID
DescriptionGet 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
URLURL
https://{api_host}/csp/gateway/am/api/orgs/{orgId}/auto-entitlement-policies/{policyId}
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
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK
Returns
ExpandedAutoEntitlementPoliciesDto
of type application/json
{
"customRoles": [
{
"createdBy": "string",
"createdDate": "string",
"expiresAt": 3609941597,
"lastUpdatedBy": "string",
"lastUpdatedDate": "string",
"membershipType": "DIRECT",
"name": "string",
"resource": "string"
}
],
"description": "string",
"displayName": "string",
"domains": [
"string"
],
"id": "string",
"lastEditedAt": "string",
"lastEditedBy": "string",
"organizationRoles": [
{
"createdBy": "string",
"createdDate": "string",
"displayName": "string",
"expiresAt": 3609941597,
"lastUpdatedBy": "string",
"lastUpdatedDate": "string",
"membershipType": "DIRECT",
"name": "string",
"resource": "string"
}
],
"serviceRoles": [
{
"serviceDefinitionId": "string",
"serviceRoleNames": [
"string"
],
"serviceRoles": [
{
"createdBy": "string",
"createdDate": "string",
"expiresAt": 3609941597,
"lastUpdatedBy": "string",
"lastUpdatedDate": "string",
"membershipType": "DIRECT",
"name": "string",
"resource": "string"
}
]
}
]
}
string
description
Optional
Description of the Auto Entitlement Policy.
string
displayName
Optional
The display name of the group.
array of
string
domains
Optional
Set of domains associated with the Auto Entitlement Policy
string
id
Optional
Unique identifier of the group.
string
lastEditedAt
Optional
Last Updated time of the Auto Entitlement Policy.
string
lastEditedBy
Optional
The username (email) of the user who edited the Auto Entitlement Policy.
Errors
CspErrorResponse
401
The user is not authorized to use the API
CspErrorResponse
403
The user is forbidden to use the API
CspErrorResponse
404
Organization with this identifier is not found. | The Auto Entitlement Policy with this identifier is not found.
CspErrorResponse
429
The user has sent too many requests
CspErrorResponse
500
An unexpected error has occurred while processing the request
Code Samples
cURL Command
curl https://{api_host}/csp/gateway/am/api/orgs/{orgId}/auto-entitlement-policies/{policyId}
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-required-roles: org_owner,org_admin,org_member
x-slo-tier: TIER2
[{"label":"Latest (v1.0)","version":"latest"}]
csp
