Jump to

• Request
• Response
• Examples

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.
• userId(optional): string
  The userId query parameter is used for filtering the entitlements for a user.

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

Type: object

Show Source

• count(optional): integer
• entitlements(optional): array entitlements
• hasMore(optional): boolean
• links(optional): array links
• totalResult(optional): 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

• 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

Resource not found

500 Response

Internal Server Error

Back to Top

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": ""
        }
    ]
}

Back to Top