In this article
Get Role
Gets a specific role.
URL
https://{{HOST}}/securityapi/role?v={version}&roleId={roleId}
Method
GET
Required IMS Scopes
- securityapi_all
Versions Supported
- 2.0 (Default)
URL Query Parameters
| Name | Description | Example | Type |
|---|---|---|---|
| v optional |
Version of the api to use | /role?v=2.0 | number |
| roleId optional |
The ID of the role. | /role?roleId=testRole | string |
Request Header Parameters
| Type | Value | Description |
|---|---|---|
| Authorization required |
Bearer {access_token} | IMS access token |
Example
Request
curl -X GET
'https://{{HOST}}/securityapi/role?v=2.0&roleId=testRole'
-H 'Authorization: Bearer {access_token}'Response
{
"name": "Analytics Admin",
"description": "Admin for Analytics service",
"id": "Analytics Admin",
"subject": "5f597832-3a0f-c472-7cd2-aea417621f9d"
}Errors
| Error | Description |
|---|---|
| Error Name | Description of Error |
Response Body Parameters
| Name | Description | Schema |
|---|---|---|
| Object Name | Description | object definition |
| name | Description | object definition |
| description | Description | object definition |
| id | Description | object definition |
| subject | Description | object definition |