1. REST API for Oracle Identity Governance Self Service
  2. Tasks
  3. Application

Get Application Instance(s)

get

/iam/governance/selfservice/api/v1/applications

Returns the list of all application instances that are available in Oracle Identity Manager. The list also provides the application instances that are hidden in the catalog. The filter query parameter should be used to get a subset of the application instances.

Request

Supported Media Types
Query Parameters
  • Attributes to be returned in the result. Comma-separated attributes are accepted.
  • Search filter to get the records. SCIM filter is accepted. There should not be any spaces for attribute value. If you want to pass space in between attribute values then replace it with "::". Supported attributes in filter are appInstanceName, appInstanceType and displayName. Sample value for filter is "appInstanceType eq Disconnected or displayName eq Plan::View or appInstanceName eq ADAppInstance". Filter also supports "offset", "limit", "orderBy". e.g: offset=3&limit=5&orderBy=appInstanceName:descending
Back to Top

Response

Supported Media Types

200 Response

Successful
Headers
Body ()
Root Schema : GetApplicationsResponse
Type: object
Show Source
Nested Schema : applications
Type: array
Show Source
Nested Schema : GetApplicationsResponseEntity
Type: object
Show Source
Nested Schema : LinkDataInstances
Type: object
Show Source

401 Response

Unauthorized

404 Response

Resource not found

500 Response

Internal Server Error

Default Response

Unexpected error
Back to Top

Examples

This example demonstrates the ability to retrieve the applications 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/applications

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/selfservice/api/v1/applications/?
offset=1&limit=10"
        },
        {
            "rel": "first",
            "href": "http://pseudo.com/iam/governance/selfservice/api/v1/applications/?
offset=1&limit=10"
        }
    ],
    "count": 3,
    "hasMore": false,
    "totalResult": -1,
    "applications": [
        {
            "links": [
                {
                    "rel": "self",
                    "href": "http://pseudo.com/iam/governance/selfservice/api/v1/applications/2"
                }
            ],
            "id": "2",
            "name": "VisionPurchasing",
            "description": "Vision Purchasing Desc",
            "displayName": "Vision Purchasing Disp",
            "type": "DOBBased"
        },
        {
            "links": [
                {
                    "rel": "self",
                    "href": "http://pseudo.com/iam/governance/selfservice/api/v1/applications/1"
                }
            ],
            "id": "1",
            "name": "VisionEmployeesDomain",
            "description": "Vision Employees Domain Desc",
            "displayName": "Vision Employees Domain Disp",
            "type": "DOBBased"
        },
        {
            "links": [
                {
                    "rel": "self",
                    "href": "http://pseudo.com/iam/governance/selfservice/api/v1/applications/3"
                }
            ],
            "id": "3",
            "name": "DisconnectedAppInstance1",
            "description": "DisconnectedAppInstance1",
            "displayName": "DisconnectedAppInstance1",
            "type": "Disconnected"
        }
    ]
}
Back to Top