REST API for Oracle Identity Governance Self Service

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: string

Attributes to be returned in the result. Comma-separated attributes are accepted. Sample value for supported attributes is "entitlementKey,entitlementValue,entitlementDisplayName"
filter: string

The filter query parameter is used for filtering the entitlements. Sample values for filter are "q=id eq 3 or name eq BH" or "q=id eq 3 and name eq BH" or "q=id eq 3".
userId: string

The userId query parameter is used for filtering the entitlements for a user.

Response

Supported Media Types

application/json

200 Response

Successful

Headers

ResponseTime: string

Captures the time in milliseconds taken for processing the request.

Root Schema : AccountsObjectGetEntitlements

Type: object

Show Source

count: integer
entitlements: array entitlements
hasMore: boolean
links: array links
totalResult: integer

{
    "properties":{
        "count":{
            "type":"integer"
        },
        "hasMore":{
            "type":"boolean"
        },
        "totalResult":{
            "type":"integer"
        },
        "entitlements":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/EntitlementData"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/LinkDataInstances"
            }
        }
    }
}

Nested Schema : entitlements

Type: array

Show Source

Array of: object EntitlementData

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

Nested Schema : links

Type: array

Show Source

Array of: object LinkDataInstances

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

Nested Schema : EntitlementData

Type: object

Show Source

accountKey: integer
chidlFormName: string
childFormValues: string
childTablePrimaryKey: integer
entListKey: integer
id: string
normalizedData: string
policyKey: integer
processInstanceKey: integer
provisionedBy: string
provisionedMechanism: string
provisionedOn: string
requestKey: string
serialVersionUid: integer
startDate: string
status: string
userKey: integer

{
    "properties":{
        "accountKey":{
            "type":"integer"
        },
        "chidlFormName":{
            "type":"string"
        },
        "childFormValues":{
            "type":"string"
        },
        "childTablePrimaryKey":{
            "type":"integer"
        },
        "entListKey":{
            "type":"integer"
        },
        "id":{
            "type":"string"
        },
        "normalizedData":{
            "type":"string"
        },
        "policyKey":{
            "type":"integer"
        },
        "processInstanceKey":{
            "type":"integer"
        },
        "provisionedBy":{
            "type":"string"
        },
        "provisionedMechanism":{
            "type":"string"
        },
        "provisionedOn":{
            "type":"string"
        },
        "requestKey":{
            "type":"string"
        },
        "serialVersionUid":{
            "type":"integer"
        },
        "startDate":{
            "type":"string"
        },
        "status":{
            "type":"string"
        },
        "userKey":{
            "type":"integer"
        }
    }
}

Nested Schema : LinkDataInstances

Type: object

Show Source

href: string
rel: string

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

401 Response

Unauthorized

404 Response

Resource not found

500 Response

Internal Server Error

Examples

This example demonstrates the ability to retrieve all the entitlements for a specific user using query parameter userId.

/iam/governance/selfservice/api/v1/entitlements?userId={userKey}

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?userId=82

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?
userId=82&offset=1&limit=10"
        },
        {
            "rel": "first",
            "href": "http://pseudo.com/iam/governance/selfservice/api/v1/entitlements?
userId=82&offset=1&limit=10"
        }
    ],
    "count": 2,
    "hasMore": false,
    "totalResult": -1,
    "entitlements": [
        {
            "links": [
                {
                    "rel": "self",
                    "href": "http://pseudo.com/iam/governance/selfservice/api/v1/entitlements/265"
                }
            ],
            "id": "265",
            "name": "CN=ADGroup_AAT,OU=MainOrg_HNK,OU=Vision,DC=adlrg12c,DC=us,DC=pseudo,DC=com",
            "description": ""
        },
        {
            "links": [
                {
                    "rel": "self",
                    "href": "http://pseudo.com/iam/governance/selfservice/api/v1/entitlements/624"
                }
            ],
            "id": "624",
            "name": "CN=ADGroup_AGI,OU=MainOrg_WMM,OU=Vision,DC=adlrg12c,DC=us,DC=pseudo,DC=com",
            "description": ""
        }
    ]
}