REST API for Oracle Identity Governance Self Service

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

Get Admin Role

get

/iam/governance/selfservice/api/v1/adminroles

Returns all the administration roles configured in Oracle Identity Manager. The administration roles for a user can be obtained using the filter query parameter. For example: /adminrole?q=userid={userId}. In scenarios where user is looking to fetch for administration roles that start with alphabet 'A' the filter query parameter can be used example: /adminrole?q=name sw 'A'

Request

Supported Media Types
  • application/json
Query Parameters
  • Attributes to be returned in the result. Comma-separated attributes are accepted. Sample value for supported attributes is "ROLE_ID, ROLE_NAME, ROLE_DISPLAY_NAME, DESCRIPTION and CUSTOM"
  • 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 roleName and roleKey. Sample value for filter is "ROLE_DISPLAY_NAME eq ITGRole or ROLE_ID eq 8". The attribute names which can be used in the filter are; ROLE_ID, ROLE_NAME, ROLE_DISPLAY_NAME, DESCRIPTION and CUSTOM
Back to Top

Response

Supported Media Types
  • application/json

200 Response

Successful
Headers
Body (
  1. BulkAdminRoleGetResponse
)
Root Schema : BulkAdminRoleGetResponse
Type: object
Show Source
  • adminroles: array adminroles
  • count: integer
  • hasMore: boolean
  • totalResult: integer
Nested Schema : adminroles
Type: array
Show Source
Nested Schema : AdminRole
Type: object
Show Source
  • custom: string
  • delayedEvaluationSet: string
  • description: string
  • displayName: string
  • id: string
  • links: array links
  • name: string
  • scoped: string
Nested Schema : LinkDataInstances
Type: object
Show Source
  • href: string
  • rel: string

401 Response

Unauthorized

404 Response

Resource not found

500 Response

Internal Server Error
Back to Top

Examples

This example retrieves all admin roles. The return information has the fields filtered. 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/adminroles?
fields=id,name,description,displayName

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/adminroles?fields=id
%2Cname%2Cdescription%2CdisplayName&offset=1&limit=10"
        },
        {
            "rel": "first",
            "href": "http://pseudo.com/iam/governance/selfservice/api/v1/adminroles?fields=id
%2Cname%2Cdescription%2CdisplayName&offset=1&limit=10"
        },
        {
            "rel": "next",
            "href": "http://pseudo.com/iam/governance/selfservice/api/v1/adminroles?fields=id
%2Cname%2Cdescription%2CdisplayName&offset=11&limit=10"
        }
    ],
    "count": 10,
    "hasMore": true,
    "totalResult": -1,
    "adminroles": [
        {
            "links": [
                {
                    "rel": "self",
                    "href": "http://pseudo.com/iam/governance/selfservice/api/v1/adminroles/1"
                }
            ],
            "id": "1",
            "name": "OrclOIMSystemAdministrator",
            "description": "OIM System Administrator Role with All Privileges",
            "displayName": "System Administrator"
        },
        {
            "links": [
                {
                    "rel": "self",
                    "href": "http://pseudo.com/iam/governance/selfservice/api/v1/adminroles/2"
                }
            ],
            "id": "2",
            "name": "OrclOIMSystemConfigurator",
            "description": "Role with privileges to configure OIM application",
            "displayName": "System Configuration Administrator"
        },
        {
            "links": [
                {
                    "rel": "self",
                    "href": "http://pseudo.com/iam/governance/selfservice/api/v1/adminroles/3"
                }
            ],
            "id": "3",
            "name": "OrclOIMCatalogAdmin",
            "description": "Role can administer all the catalog items",
            "displayName": "Catalog System Administrator"
        },
        {
            "links": [
                {
                    "rel": "self",
                    "href": "http://pseudo.com/iam/governance/selfservice/api/v1/adminroles/4"
                }
            ],
            "id": "4",
            "name": "OrclOIMRoleAdministrator",
            "description": "Role can manage all assigned enterprise roles",
            "displayName": "Role Administrator"
        },
        {
            "links": [
                {
                    "rel": "self",
                    "href": "http://pseudo.com/iam/governance/selfservice/api/v1/adminroles/5"
                }
            ],
            "id": "5",
            "name": "OrclOIMRoleAuthorizer",
            "description": "Role can authorize assigned enterprise roles",
            "displayName": "Role Authorizer"
        },
        {
            "links": [
                {
                    "rel": "self",
                    "href": "http://pseudo.com/iam/governance/selfservice/api/v1/adminroles/6"
                }
            ],
            "id": "6",
            "name": "OrclOIMRoleViewer",
            "description": "Role can view assigned enterprise roles.",
            "displayName": "Role Viewer"
        },
        {
            "links": [
                {
                    "rel": "self",
                    "href": "http://pseudo.com/iam/governance/selfservice/api/v1/adminroles/7"
                }
            ],
            "id": "7",
            "name": "OrclOIMEntitlementAdministrator",
            "description": "Entitlement administrator",
            "displayName": "Entitlement Administrator"
        },
        {
            "links": [
                {
                    "rel": "self",
                    "href": "http://pseudo.com/iam/governance/selfservice/api/v1/adminroles/8"
                }
            ],
            "id": "8",
            "name": "OrclOIMEntitlementAuthorizer",
            "description": "Entitlement authorizer",
            "displayName": "Entitlement Authorizer"
        },
        {
            "links": [
                {
                    "rel": "self",
                    "href": "http://pseudo.com/iam/governance/selfservice/api/v1/adminroles/9"
                }
            ],
            "id": "9",
            "name": "OrclOIMEntitlementViewer",
            "description": "Role can view assigned entitlements.",
            "displayName": "Entitlement Viewer"
        },
        {
            "links": [
                {
                    "rel": "self",
                    "href": "http://pseudo.com/iam/governance/selfservice/api/v1/adminroles/10"
                }
            ],
            "id": "10",
            "name": "OrclOIMApplicationInstanceAdministratorRole",
            "description": "Role can manage assigned application instances.",
            "displayName": "Application Instance Administrator"
        }
    ]
}
Back to Top