Get an admin entitlement.

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

Entitlements required: tenantadmin [Tenant Administrator].

Responses

Response body

object

code

string

Unique identifier of the admin entitlement.

name

string

required

Name of the admin entitlement.

label

string

Localization name of the admin entitlement.

description

string

Description of the admin entitlement.

type

string

required

Type of the admin entitlement.

role permission

subType

string

Sub type of the admin entitlement.

regular dynamic

ootb

boolean

Out Of the box content

disabled

boolean

Indicate if the admin entitlement is disabled.

status

string

Status of a dynamic admin entitlement

waiting inprogress reviewpublish active active_waiting active_inprogress active_reviewpublish inactive

hasScope

int32

Indicate the the entitlement has scope. If the value is 0 the entitlement doesn't have scope, otherwise the entitlement has scope.

1

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

subscription

string

Subscription of the admin entitlement.

countChildren

int32

Number of entitlement contained in the role

creationUserDetails

object

Rest representation for a user.

string

userName

string

Username

string

givenName

string

FirstName

familyName

string

LastName

lastModUserDetails

object

Rest representation for a user.

string

userName

string

Username

string

givenName

string

FirstName

familyName

string

LastName

properties

object

resourceType

string

Indicate the resource type 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

countChildrenPermissions

int32

Number of permissions contained in the role

countUsers

int32

Number of users granted

countGroups

int32

Number of groups granted

evaluationStartTime

date-time

Evaluation start time

evaluationEndTime

date-time

Evaluation end time

errorMessage

string

Error message for failed admin entitlement

updatedConditionSet

array of objects

updatedConditionSet

object

creationUser

string

Indicate the id of who is the creator of the admin entitlement.

creationDate

date-time

Indicate the creation date of the admin entitlement.

lastModUser

string

Indicate the id of who is the last user that has changed the admin 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/admin/entitlements/entitlement?details=false' \
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.