Get role information

 
MethodURIDescription
GET/v2.0/OS-KSADM/roles/{roleId}

Gets information for a specified role.

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)

 Request

This table shows the header parameters for the get role information request:

NameTypeDescription

X-Auth-Token

​String

(Required)

A valid authentication token for an administrative user.

This table shows the URI parameters for the get role information request:

NameTypeDescription

{roleId}

​String

The role ID.

This operation does not require a request body.

 Response

This table shows the header parameters for the get role information response:

NameTypeDescription

Location

​Any​U​RI

(Optional)

The location.

 

Example 4.21. Get role information: 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.22. Get role information: JSON response

{
  "role": {
    "id": "123",
    "name": "Guest",
    "description": "Guest Access"
  }
}

Questions? Discuss on ask.openstack.org
Found an error? Report a bug against this page

loading table of contents...