User Options

The /adminroles GET obtains the admin roles(s) for the users, which determines what functionality is available for them.

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

{
    "links": [
        {
            "rel": "self",
            "href": "https://pseudo.com/iam/governance/selfservice/api/v1/adminroles?fields=id
%2Cname%2Cdescription%2CdisplayName&offset=1&limit=10"
        },
        {
            "rel": "first",
            "href": "https://pseudo.com/iam/governance/selfservice/api/v1/adminroles?fields=id
%2Cname%2Cdescription%2CdisplayName&offset=1&limit=10"
        },
        {
            "rel": "next",
            "href": "https://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": "https://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": "https://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": "https://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": "https://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": "https://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": "https://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": "https://pseudo.com/iam/governance/selfservice/api/v1/adminroles/7"
                }
            ],
            "id": "7",
            "name": "OrclOIMEntitlementAdministrator",
            "description": "Entitlement administrator",
            "displayName": "Entitlement Administrator"
        },
        {
            "links": [
                {
                    "rel": "self",
                    "href": "https://pseudo.com/iam/governance/selfservice/api/v1/adminroles/8"
                }
            ],
            "id": "8",
            "name": "OrclOIMEntitlementAuthorizer",
            "description": "Entitlement authorizer",
            "displayName": "Entitlement Authorizer"
        },
        {
            "links": [
                {
                    "rel": "self",
                    "href": "https://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": "https://pseudo.com/iam/governance/selfservice/api/v1/adminroles/10"
                }
            ],
            "id": "10",
            "name": "OrclOIMApplicationInstanceAdministratorRole",
            "description": "Role can manage assigned application instances.",
            "displayName": "Application Instance Administrator"
        }
    ]
}