Get Entitlements List
get
/iam/governance/selfservice/api/v1/entitlements
Returns all the entitlements available in Oracle Identity Manager.
The entitlements that are hidden in the catalog are also returned. The entitlements can be filtered.
Request
Supported Media Types
- application/json
Query Parameters
-
fields(optional): string
Attributes to be returned in the result. Comma-separated attributes are accepted. Sample value for supported attributes is "entitlementKey,entitlementValue,entitlementDisplayName"
-
filter(optional): string
The filter query parameter is used for filtering the entitlements.
Response
Supported Media Types
- application/json
200 Response
Successful
Headers
-
ResponseTime: string
Captures the time in milliseconds taken for processing the request.
401 Response
Unauthorized
404 Response
Resource not found
500 Response
Internal Server Error
Examples
This demonstrates the ability to retrieve all entitlement that do not have an entitlementKey of 1. The information shown here is against a pseudo system and serves as a prototype.
cURL Example
curl -H "Content-Type: application/json" -X GET -u username:password "https://pseudo.com/iam/governance/selfservice/api/v1/entitlements?q=entitlementKey ne 1"
Example of Response Body
The following example shows the contents of the response body in JSON format.
{
"links": [
{
"rel": "self",
"href": "http://pseudo.com/iam/governance/selfservice/api/v1/entitlements?offset=1&limit=10&q=entitlementKey ne 1"
},
{
"rel": "first",
"href": "http://pseudo.com/iam/governance/selfservice/api/v1/entitlements?offset=1&limit=10&q=entitlementKey ne 1"
},
{
"rel": "last",
"href": "http://pseudo.com/iam/governance/selfservice/api/v1/entitlements?offset=11&limit=10&q=entitlementKey ne 1"
},
{
"rel": "next",
"href": "http://pseudo.com/iam/governance/selfservice/api/v1/entitlements?offset=11&limit=10&q=entitlementKey ne 1"
}
],
"count": 10,
"entitlements": [
{
"links": [
{
"rel": "self",
"href": "http://pseudo.com/iam/governance/selfservice/api/v1/entitlements/42"
}
],
"id": "42",
"name": "ENT3DAI2",
"description": ""
},
{
"links": [
{
"rel": "self",
"href": "http://pseudo.com/iam/governance/selfservice/api/v1/entitlements/41"
}
],
"id": "41",
"name": "ENT2DAI2",
"description": ""
},
{
"links": [
{
"rel": "self",
"href": "http://pseudo.com/iam/governance/selfservice/api/v1/entitlements/21"
}
],
"id": "21",
"name": "44~ent1",
"description": ""
},
{
"links": [
{
"rel": "self",
"href": "http://pseudo.com/iam/governance/selfservice/api/v1/entitlements/53"
}
],
"id": "53",
"name": "DAI1ENT6",
"description": ""
},
{
"links": [
{
"rel": "self",
"href": "http://pseudo.com/iam/governance/selfservice/api/v1/entitlements/52"
}
],
"id": "52",
"name": "DAI1ENT11",
"description": ""
},
{
"links": [
{
"rel": "self",
"href": "http://pseudo.com/iam/governance/selfservice/api/v1/entitlements/51"
}
],
"id": "51",
"name": "DAI1ENT7",
"description": ""
},
{
"links": [
{
"rel": "self",
"href": "http://pseudo.com/iam/governance/selfservice/api/v1/entitlements/50"
}
],
"id": "50",
"name": "DAI1ENT10",
"description": ""
},
{
"links": [
{
"rel": "self",
"href": "http://pseudo.com/iam/governance/selfservice/api/v1/entitlements/49"
}
],
"id": "49",
"name": "DAI1ENT9",
"description": ""
},
{
"links": [
{
"rel": "self",
"href": "http://pseudo.com/iam/governance/selfservice/api/v1/entitlements/48"
}
],
"id": "48",
"name": "DAI1ENT8",
"description": ""
},
{
"links": [
{
"rel": "self",
"href": "http://pseudo.com/iam/governance/selfservice/api/v1/entitlements/47"
}
],
"id": "47",
"name": "DAI1ENT2",
"description": ""
}
]
}