Get Entitlement Details
get
/iam/governance/selfservice/api/v1/entitlements/{entid}
Returns the entitlement details of the specified entitlement ID. The attributes that are to be returned can be specified as part of the query parameter named "fields". For example: The URI to get the name and description attributes only for a particular entitlement is /entitlement/{entid}?fields=entitlementValue, description. The attributes are to be spcified in a Comma-separated list.
Request
Supported Media Types
- application/json
Path Parameters
-
entid: string
Entitlement id
Query Parameters
-
fields(optional): string
Attributes to be returned in the result. Comma-separated attributes are accepted.
Response
Supported Media Types
- application/json
200 Response
Successful
Headers
-
ResponseTime: string
Captures the time in milliseconds taken for processing the request.
Root Schema : EntitlementData
Type:
Show Source
object
-
accountKey(optional):
integer
-
chidlFormName(optional):
string
-
childFormValues(optional):
string
-
childTablePrimaryKey(optional):
integer
-
entListKey(optional):
integer
-
id(optional):
string
-
normalizedData(optional):
string
-
policyKey(optional):
integer
-
processInstanceKey(optional):
integer
-
provisionedBy(optional):
string
-
provisionedMechanism(optional):
string
-
provisionedOn(optional):
string
-
requestKey(optional):
string
-
serialVersionUid(optional):
integer
-
startDate(optional):
string
-
status(optional):
string
-
userKey(optional):
integer
401 Response
Unauthorized
404 Response
Requested entity not found
500 Response
Internal Server Error
Examples
This demonstrates the ability to retrieve a single entitlement in OIM. 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/1
Example of GET Response Body
The following example shows the contents of the response body in JSON format.
{ "links": [ { "rel": "self", "href": "http://pseudo.com/iam/governance/adminservice/api/v1/entitlements/1" } ], "id": "1", "status": "Provisioned", "entListKey": 624, "provisionedOn": 1552344227000, "startDate": "2019-03-11T22:43:47Z", "requestKey": "5", "provisionedMechanism": "REQUEST", "provisionedBy": "5", "processInstanceKey": 201, "policyKey": 0, "accountKey": 2, "userKey": 82, "serialVersionUid": 2, "chidlFormName": "UD_ADUSRC", "childFormValues": { "UD_ADUSRC_GROUPNAME": "8~CN=ADGroup_AGI,OU=MainOrg_WMM,OU=Vision,DC=adlrg12c,DC=us,DC=pseudo,DC=com" }, "normalizedData": { "Group Name": [ "8~CN=ADGroup_AGI,OU=MainOrg_WMM,OU=Vision,DC=adlrg12c,DC=us,DC=pseudo,DC=com" ] }, "childTablePrimaryKey": 1 }