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
Path Parameters
Query Parameters
Back to Top

Response

Supported Media Types

200 Response

Successful
Headers
Body ()
Root Schema : EntitlementData
Type: object
Show Source
Nested Schema : AppInstanceReference
Type: object
Show Source
Nested Schema : LinkDataInstances
Type: object
Show Source

401 Response

Unauthorized

404 Response

Requested entity not found

500 Response

Internal Server Error
Back to Top

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.

{
  "id": "1",
  "name": "\"abc_meaning1\"",
  "description": "",
  "links": [
    {
      "rel": "self",
      "href": "http://pseudo.com/iam/governance/selfservice/api/v1/entitlements/1"
    }
  ]
}
Back to Top