Returns all Entitlement resources.
GET/Entitlements
This endpoint returns all Entitlement resources.
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.
The schemas related to Entitlements are:
- urn:ietf:params:scim:schemas:sailpoint:1.0:Entitlement
Request
Query Parameters
Allows for query filters according to RFC-7644, Section 3.4.2.2 - not all operations are supported.
Allows sorting the results by a resource's attributes.
Default value: ascending
Determines what order to sort results in.
Default value: 1
Determines the starting index of the result set.
Default value: 1000
Specifies the number of results per page.
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
Returned all SCIM resources for this endpoint.
- application/json
- application/scim+json
- Schema
- Example (from schema)
Schema
Array [
Array [
]
Array [
]
]
Number of resources returned for this endpoint.
The starting index of the resource set list. Can be specified with startIndex query parameter.
SCIM Schema used for response.
Resources
undefined[]
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 display name 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.
{
"totalResults": "1,",
"startIndex": 1,
"schemas": [
"urn:ietf:params:scim:api:messages:2.0:ListResponse"
],
"Resources": [
{
"id": "7f00000180281df7818028bfb83204dc",
"descriptions": {
"locale": "en_GB",
"value": "<strong>**AP_Logins**</strong> Target Friendly Description"
},
"displayName": "AP_Logins",
"type": "Permission",
"application": [
{
"value": "7f00000180281df7818028bfac5a0367",
"$ref": "http://localhost:8080/identityiq/scim/v2/Applications/7f00000180281df7818028bfed100826",
"displayName": "Oracle_DB_oasis"
}
],
"owner": [
{
"value": "7f00000180281df7818028bfb0d103c7",
"$ref": "http://localhost:8080/identityiq/scim/v2/Users/7f00000180281df7818028bfb0d103c7",
"displayName": "Debra Wood"
}
],
"requestable": true,
"aggregated": true,
"attribute": "AP_Logins",
"value": "CN=AP_Logins,OU=Security,OU=Permissions,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": "ClassificationB",
"displayName": "ClassB",
"origin": "PAMSource",
"type": "Aggregation"
}
},
"meta": {
"created": "2022-04-14T10:44:54.834-05:00",
"location": "http://localhost:8080/identityiq/scim/v2/Entitlements/7f00000180281df7818028bfb83204dc",
"lastModified": "2022-04-05T15:52:30.119-05:00",
"version": "\"W\"1649951094834\"",
"resourceType": "Entitlement"
},
"schemas": [
"urn:ietf:params:scim:schemas:sailpoint:1.0:Entitlement"
],
"entitleAuth": "Low",
"entDate": "2022-04-14T10:44:54.738-05:00",
"active": false,
"rank": 3,
"rule": "APLogin-Contractors-Rule",
"reviewer": {
"displayName": "Dan Patrick",
"value": "c0b4568a4fe7458c434ee77f2fad267c",
"$ref": "http://localhost:8080/identityiq/scim/v2/Users/c0b4568a4fe7458c434ee77f2fad267c"
},
"email": "[email protected]"
}
]
}
- Schema
- Example (from schema)
Schema
Array [
Array [
]
Array [
]
]
Number of Entitlement resources returned.
The starting index of the resource set list. Can be specified with startIndex query parameter.
SCIM Schema used for response.
Resources
undefined[]
The SCIM resources returned for this endpoint.
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 display name 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.
{
"totalResults": "1500,",
"startIndex": 1,
"schemas": [
"urn:ietf:params:scim:api:messages:2.0:ListResponse"
],
"Resources": [
{
"id": "7f00000180281df7818028bfb83204dc",
"descriptions": {
"locale": "en_GB",
"value": "<strong>**AP_Logins**</strong> Target Friendly Description"
},
"displayName": "AP_Logins",
"type": "Permission",
"application": [
{
"value": "7f00000180281df7818028bfac5a0367",
"$ref": "http://localhost:8080/identityiq/scim/v2/Applications/7f00000180281df7818028bfed100826",
"displayName": "Oracle_DB_oasis"
}
],
"owner": [
{
"value": "7f00000180281df7818028bfb0d103c7",
"$ref": "http://localhost:8080/identityiq/scim/v2/Users/7f00000180281df7818028bfb0d103c7",
"displayName": "Debra Wood"
}
],
"requestable": true,
"aggregated": true,
"attribute": "AP_Logins",
"value": "CN=AP_Logins,OU=Security,OU=Permissions,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": "ClassificationB",
"displayName": "ClassB",
"origin": "PAMSource",
"type": "Aggregation"
}
},
"meta": {
"created": "2022-04-14T10:44:54.834-05:00",
"location": "http://localhost:8080/identityiq/scim/v2/Entitlements/7f00000180281df7818028bfb83204dc",
"lastModified": "2022-04-05T15:52:30.119-05:00",
"version": "\"W\"1649951094834\"",
"resourceType": "Entitlement"
},
"schemas": [
"urn:ietf:params:scim:schemas:sailpoint:1.0:Entitlement"
],
"entitleAuth": "Low",
"entDate": "2022-04-14T10:44:54.738-05:00",
"active": false,
"rank": 3,
"rule": "APLogin-Contractors-Rule",
"reviewer": {
"displayName": "Dan Patrick",
"value": "c0b4568a4fe7458c434ee77f2fad267c",
"$ref": "http://localhost:8080/identityiq/scim/v2/Users/c0b4568a4fe7458c434ee77f2fad267c"
},
"email": "[email protected]"
}
]
}