Get the entitlement details.

get https://{tenanturl}/v1.0/entitlements/{entitlement}

Entitlements required: tenantadmin [Tenant Administrator], manageAppAccessOwner [Manage Application Entitlements].

Responses

Response body

object

code

string

Unique identifier of the entitlement

name

string

required

Name of the entitlement. Unique accross the application

description

string

Description

type

string

required

Type of the entitlement

role permission

subType

string

Sub type of the entitlement.

regular dynamic

disabled

boolean

Indicate if the entitlement is disabled.

status

string

Status of a dynamic entitlement

waiting inprogress reviewpublish active active_waiting active_inprogress active_reviewpublish inactive

application

string

required

Unique identifier of the application

category

string

Category of the entitlement.

rights

boolean

Indicate if the entitlement has rights

extRef

string

Unique identifier of the mapped object in the connected application.

assignPolicy

int32

Indicate the assign policy of the entitlement. If the value is 0 the entitlement can be assigned manually, otherwise the entitlement can not be assigned by the user.

1

properties

object

rightsRef

string

Rights reference to lookup rights values.

rightsLabel

string

Rights label to display on UI.

mandatory

string

Indicate if the entitlement is mandatory

multivalue

string

Indicate if the entitlement can have one or more right values

type

string

Indicate the type of the right value

canonicalValues

array of strings

Indicate the canonical values supported by permission

canonicalValues

owner

string

Id of the user owner of the entitlement.

conditionSet

array of objects

Condition set to determine the users that belong to this role. And, Example value:[{"erDepartment":[{"op":"eq","vl":"Security"},{"op":"ne","vl":"Sales"}],"erPersonType":[{"op":"sw","vl":"Employee"},{"op":"ne","vl":"Contractor"}]},{"erDepartment":[{"op":"eq","vl":"Marketing"}]}]

conditionSet

object

fixedRights

array of objects

Fixed right values of the entitlement

fixedRights

object

entitlement

string

Unique identifier of the permission

values

array of strings

Values of the rights

values

evaluationStartTime

date-time

Evaluation start time

evaluationEndTime

date-time

Evaluation end time

errorMessage

string

Error message for failed entitlement

updatedConditionSet

array of objects

updatedConditionSet

object

creationUser

string

Indicate the id of who is the creator of the entitlement

creationDate

date-time

Indicate the creation date of the entitlement

lastModUser

string

Indicate the id of who is the last user that has changed the entitlement

lastModTime

date-time

Indicate the last modification date of the entitlement

500

Your request can't be processed because an internal server error occurred.

Language

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://tenant_url/v1.0/entitlements/entitlement \
3
     --header 'accept: application/json'

Choose an example:

application/json

200The request was successful.

400An application status error occurred. The error code and description are available in the payload.