/api/space/user-management/roles/{id} (v1)

The following operations are supported on this resource:

  • GET - Get a single role
GET /roles/{id}
(Deprecated)
Version 1

Get a single role.

Sample Usage

GET /roles/{id}


  • Parameters:
    Name Type URI Type Description Required
    id int Path The ID of the role for which information will be retrieved. Y
  • Sample Output XML:
    <role uri="api/space/user-management/roles/54" >
        <id>54</id>
        <name>superAdmin</name>
        <title>Super Administrator</title>
        <description>Super Administrator</description>
        <capabilities uri="api/space/user-management/roles/54/capabilities">
           <capability uri="api/space/user-management/roles/54/capabilities/22"
                       href="/api/space/user-management/capabilities/22">
             <id>22</id>
             <name>SuperCop</name& gt;
           </capability>
        </capabilities>
    </role>

  • Sample Output JSON:
    {
      "role":{
          "@uri":"api/space/user-management/roles/54"
          "id":54,
          "name":"superAdmin",
          "title":"Super Administrator",
          "description":"Super Administrator",
          "capabilities":{
                "@uri": "api/space/user-management/roles/54/capabilities",
                 "capability": {
                   ;    "@uri": "/api/space/user-management/roles/54/capabilities/22",
                   ;     @href":"/api/space/user-management/capabilities/22",
            "id":22,
            "name":"SuperCop"
          }
        }
      }
    }

  • Access Control

    The following capabilities are required to access this API: ReadRole

      For the current version of this API, refer to :
    • version 3