Jump to

• Request
• Response
• Examples

Get Admin Role Based on Admin Role ID

get

/iam/governance/selfservice/api/v1/adminroles/{adminroleid}

Returns the admin role details of the specified admin role id. The attributes that are to be returned can be specified as part of the query parameter named "fields". For example: The URI to get the name and description attributes only for a particular admin role is /adminroles/{adminroleid}?fields=displayName, description. The attributes are to be specified in a Comma-separated list.

Request

Supported Media Types

• application/json

Path Parameters

• adminroleid: string
  Admin Role ID

Query Parameters

• fields(optional): string
  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"

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

Type: object

Show Source

• custom(optional): string
• delayedEvaluationSet(optional): string
• description(optional): string
• displayName(optional): string
• id(optional): string
• links(optional): array links
• name(optional): string
• scoped(optional): string

{
    "properties":{
        "id":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "displayName":{
            "type":"string"
        },
        "delayedEvaluationSet":{
            "type":"string"
        },
        "scoped":{
            "type":"string"
        },
        "custom":{
            "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 : LinkDataInstances

Type: object

Show Source

• href(optional): string
• rel(optional): string

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

401 Response

Unauthorized

404 Response

Requested entity not found

500 Response

Internal Server Error

Back to Top

Examples

This example retrieves the information for a given admin role. 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/12

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/12"
    }
  ],
  "id": "12",
  "name": "OrclOIMApplicationInstanceViewerRole",
  "description": "Role can view assigned application instances.",
  "displayName": "Application Instance Viewer",
  "delayedEvaluationSet": true,
  "scoped": true,
  "custom": false
}

Back to Top