Returns all Entitlement resources.
GET {{baseUrl}}/Entitlements?filter=<string>&sortBy=<string>&sortOrder=ascending&startIndex=1&count=1000&attributes=<string>&excludedAttributes=<string>
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 Params
| Key | Datatype | Required | Description |
|---|---|---|---|
filter | string | Allows for query filters according to RFC-7644, Section 3.4.2.2 - not all operations are supported. | |
sortBy | string | Allows sorting the results by a resource's attributes. | |
sortOrder | string | Determines what order to sort results in. | |
startIndex | number | Determines the starting index of the result set. | |
count | number | Specifies the number of results per page. | |
attributes | string | 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. | |
excludedAttributes | string | A comma-separated list of attributes to exclude from the response. Some attributes cannot be excluded. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"totalResults":-36747162,"startIndex":1,"schemas":["urn:ietf:params:scim:api:messages:2.0:ListResponse"],"Resources":[{"id":"7f00000180281df7818028bfb83204dc","descriptions":{"locale":"en_GB","value":"\u003cstrong\u003e**AP_Logins**\u003c/strong\u003e Target Friendly Description"},"displayName":"AP_Logins","type":"Permission","application":[{"value":"7f00000180281df7818028bfac5a0367","$ref":"http://localhost:8080/identityiq/scim/v2/Applications/7f00000180281df7818028bfed100826","displayName":"Oracle_DB_oasis"},{"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"},{"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":{"classification":{"name":"ClassificationB","displayName":"ClassB","origin":"PAMSource","type":"Aggregation"},"source":"UI","effective":false},"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":"dpatrick@demoexample.com"},{"id":"7f00000180281df7818028bfb83204dc","descriptions":{"locale":"en_GB","value":"\u003cstrong\u003e**AP_Logins**\u003c/strong\u003e Target Friendly Description"},"displayName":"AP_Logins","type":"Permission","application":[{"value":"7f00000180281df7818028bfac5a0367","$ref":"http://localhost:8080/identityiq/scim/v2/Applications/7f00000180281df7818028bfed100826","displayName":"Oracle_DB_oasis"},{"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"},{"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":{"classification":{"name":"ClassificationB","displayName":"ClassB","origin":"PAMSource","type":"Aggregation"},"source":"UI","effective":false},"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":"dpatrick@demoexample.com"}]}