/api/space/user-management/roles (v2)

The following operations are supported on this resource:

GET /roles
(Deprecated)
Version 2

This API is used to retrieve all the roles, returning a collection of roles.

Sample Usage

GET /roles


  • Sample Output XML:
    <roles size="3" uri="/api/space/user-management/roles" >
        <role key="54" uri="/api/space/user-management/roles/54"
              href= "/api/space/user-management/roles/54" >
            <title>Super Administrator</name>
        </role>
        <role key="56" uri="/api/space/user-management/roles/56"
             href= "/api/space/user-management/roles/56" >
            <title>User Administrator</name>
        </role>
        <role key="58" uri="/api/space/user-management/roles/58"
              href= "/api/space/user-management/roles/58" >
            <title>Tag Administrator</name>
        </role>
    </roles>

  • Sample Output JSON:
    {
      "roles": {
           "@size":"3",
           "@uri":"api/space/user-management/roles"
           {
             "role": [
                 {
                   ; "@key":"54",
                   ; "@uri":"/api/space/user-management/roles/54",
                   ; "@href":"/api/space/user-management/roles/54",
                   ; "title":"Super Administrator"
                 },
                 {
                   ; "@key":"56",
                   ; "@uri":"/api/space/user-management/roles/56",
                   ; "@href":"/api/space/user-management/roles/56",
                   ; "title":"User Administrator"
                 },
                 {
                   ; "@key":"58",
                   ; "@uri":"/api/space/user-management/roles/58",
                   ; "@href":"/api/space/user-management/roles/58",
                   ; "title":"Tag Administrator"}
             ]
           }
       }
    }

  • Access Control

    The following capabilities are required to access this API: ReadRole

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