Returns an Entitlement resource based on id.
GET/Entitlements/:entitlementId
The Entitlement resource with matching id is returned.
Attributes to include in the response can be specified with the attributes query parameter.
Attributes to exclude from the response can be specified with the excludedAttributes query parameter.
Request
Path Parameters
id of Entitlement resource.
Query Parameters
A comma-separated list of attributes to return in the response. This query parameter supersedes excludedAttributes, so providing the same attribute(s) to both will result in the attribute(s) being returned.
A comma-separated list of attributes to exclude from the response. Some attributes cannot be excluded.
Responses
- 200
Returns a single Entitlement resource based on the id.
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
Array [
]
Unique identifier of the Entitlement.
descriptions
object
A list of localized descriptions of the Entitlement.
The locale associated with this Entitlement description.
The description in localized form.
Displayable name of the Entitlement.
Type of the Entitlement.
application
undefined[]
The corresponding Application object of the Entitlement.
The Application associated with the Entitlement.
The URI of the SCIM resource representating the Entitlement application.
The name of the Entitlement Application. OPTIONAL and READ-ONLY.
owner
undefined[]
The owner of the Entitlement.
The id of the SCIM resource representing the Entitlement Owner.
The URI of the SCIM resource representing the Entitlement Owner.
The displayName of the Entitlement Owner. OPTIONAL and READ-ONLY.
Flag to indicate this entitlement is requestable.
Flag to indicate this entitlement has been aggregated.
Attribute of the Entitlement.
Attribute value of the Entitlement.
The DateTime when the Entitlement was refreshed.
The date aggregation was last targeted of the Entitlement.
classifications
object
Classifications of this Entitlement.
The source of the ObjectClassification.
Flag indicating this is an effective Classification.
classification
object
required
Classification of this object.
The name of the Classification.
The displayName of the Classification.
The origin of the Classification.
The type of the Classification.
meta
object
DateTime when the Entitlement was created.
URL to the Entitlement.
DateTime of Entitlement last modification.
Entitlement version.
Resource type of the metadata subject.
This is an Extended Attribute from Managed Attribute used to describe the authorization level of an Entitlement.
This is an Extended Attribute from Managed Attribute. The Entitlement DateTime.
This is an Extended Attribute from Managed Attribute. Describes if an Entitlement is active.
This is an Extended Attribute from Managed Attribute.
This is an Extended Attribute from Managed Attribute. Used to specify a Rule object for the Entitlement.
reviewer
object
This is an Extended Attribute from Managed Attribute. The Identity that reviewed the Entitlement.
Display name of the Entitlement reviewer.
id of the Entitlement reviewer.
URI reference of the Entitlement reviewer resource.
This is an Extended Attribute from Managed Attribute. Used to specify the Entitlement owner email.
{
"id": "7f00000180281df7818028bfb7d204c1",
"descriptions": {
"locale": "en_US",
"value": "<strong>**Employee Database**</strong> <em>target friendly description</em>"
},
"displayableName": "a2a",
"type": "group",
"application": [
{
"value": "7f00000180281df7818028bfed100826",
"$ref": "http://localhost:8080/identityiq/scim/v2/Applications/7f00000180281df7818028bfed100826",
"displayName": "SAP"
}
],
"owner": [
{
"value": "7f00000180281df7818028bfab930361",
"$ref": "http://localhost:8080/identityiq/scim/v2/Users/7f00000180281df7818028bfab930361",
"displayName": "Mary Johnson"
}
],
"requestable": true,
"aggregated": true,
"attribute": "memberOf",
"value": "CN=a2a,OU=HierarchicalGroups,OU=DemoData,DC=test,DC=sailpoint,DC=com",
"lastRefresh": "2022-04-14T10:48:01.907-05:00",
"lastTargetAggregation": "2022-04-14T10:48:01.907-05:00",
"classifications": {
"source": "UI",
"effective": false,
"classification": {
"name": "ClassificationA",
"displayName": "ClassA",
"origin": "FAM Aggregation",
"type": "Aggregation"
}
},
"meta": {
"created": "2022-04-05T15:52:30.090-05:00",
"location": "http://localhost:8080/identityiq/scim/v2/Entitlements/c0a8019c7ffa186e817ffb80170a0195",
"lastModified": "2022-04-05T15:52:30.119-05:00",
"version": "\"W\"1649191950119\"",
"resourceType": "Entitlement"
},
"schemas": [
"urn:ietf:params:scim:schemas:sailpoint:1.0:Entitlement"
],
"entitleAuth": "None",
"entDate": "2022-04-14T10:44:54.738-05:00",
"active": false,
"rank": 3,
"rule": "APLogin-Contractors-Rule",
"reviewer": {
"displayName": "Caroline Lee",
"value": "c0b4568a4fe7458c434ee77f2fad267c",
"$ref": "http://localhost:8080/identityiq/scim/v2/Users/c0b4568a4fe7458c434ee77f2fad267c"
},
"emails": "[email protected]"
}