Jump to

• Request
• Response
• Examples

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.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful

Headers

• ResponseTime: string
  Captures the time in milliseconds taken for processing the request.

Body ()

Root Schema : EntitlementData

Type: object

Show Source

• applicationInstanceName(optional): object AppInstanceReference
• description(optional): string
• formName(optional): string
• id(optional): string
• itResourseName(optional): string
• links(optional): array links
• name(optional): string

{
    "properties":{
        "id":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "itResourseName":{
            "type":"string"
        },
        "applicationInstanceName":{
            "$ref":"#/definitions/AppInstanceReference"
        },
        "formName":{
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/LinkDataInstances"
            }
        }
    }
}

Nested Schema : AppInstanceReference

Type: object

Show Source

• links(optional): array links
• name(optional): string
• value(optional): string

{
    "properties":{
        "name":{
            "type":"string"
        },
        "value":{
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/LinkDataInstances"
            }
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object LinkDataInstances

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/LinkDataInstances"
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object LinkDataInstances

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/LinkDataInstances"
    }
}

Nested Schema : LinkDataInstances

Type: object

Show Source

• href(optional): string
• rel(optional): string

{
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        }
    }
}

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.

{
    "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
}

Back to Top