User Management API

/api/space/user-management/roles/{id}

The following operations are supported on this resource:

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


This API takes a role ID as an argument and returns a Role transfer object containing information about the specified role.

Access Control

The following capabilities are required to access this API:
"ReadRole"


Example Usage

GET /api/space/user-management/roles/{id}


Parameters

NameTypeURI TypeDescriptionRequired
idintPathThe ID of the role for which information will be retrieved. Y

Content Types

  • Produces content types:
    application/vnd.net.juniper.space.user-management.role+xml;version=1
    application/vnd.net.juniper.space.user-management.role+json;version=1


  • 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>
        </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"
          }
        }
    }}