| Method | URI | Description |
|---|---|---|
| GET | /v2.0/OS-KSADM/roles | Gets a role by name. |
Normal response codes: 200, 203
Error response codes: identityFault (400, 500, …), badRequest (400), unauthorized (401), forbidden (403), badMethod (405), overLimit (413), serviceUnavailable (503), badMediaType (415), itemNotFound (404)
This table shows the header parameters for the get role information by name request:
| Name | Type | Description |
|---|---|---|
| String (Required) | A valid authentication token for an administrative user. |
This operation does not require a request body.
This table shows the header parameters for the get role information by name response:
| Name | Type | Description |
|---|---|---|
| AnyURI (Optional) | The location. |
Example 4.13. Get role information by name: XML response
<?xml version="1.0" encoding="UTF-8"?> <role xmlns="http://docs.openstack.org/identity/api/v2.0" id="123" name="Admin" description="All Access" />
Example 4.14. Get role information by name: JSON response
{
"role": {
"id": "123",
"name": "Guest",
"description": "Guest Access"
}
}
