REST Resources

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

The following operation is supported on this resource:

  • GET - Get all roles for a remote profile
GET /profiles/{id}/roles Version 1

This API retrieves all the roles in a particular remote profile.

Sample Usage

GET /profiles/{id}/roles


  • Parameters:
    Name Type URI Type Description Required
    id int Path The ID of the remote profile for which all roles will be retrieved. Y
  • Sample Output XML:
    <roles size="2" uri="/api/space/user-management/profiles/458785/roles">
      <role uri="/api/space/user-management/profiles/458785/roles/65696"
           href= "/api/space/user-management/roles/65696" key="65696">
        <id>65696</id>
        <name>userAdmin</name>
      </role>
      <role uri="/api/space/user-management/profiles/458785/roles/65699"
            href= "/api/space/user-management/roles/65699" key="65699">
        <id>65699</id>
        <name>systemAdmin</name>
      </role>
    </roles>

  • Sample Output JSON:
    {
     "roles":{
      "@size":"2",
      "@uri":"/api/space/user-management/profiles/458785/roles",
      "role":[
       {
        "@uri": "/api/space/user-management/profiles/458785/roles/65696",
        "@href":"/api/space/user-management/roles/65696",
        "@key":"65696",
        "id":65696,
        "name":"userAdmin"
       },
       {
        "@uri": "/api/space/user-management/profiles/458785/roles/65699",
        "@href":"/api/space/user-management/roles/65699",
        "@key":"65699",
        "id":65699,
        "name":"systemAdmin"
       }
      ]
     }
    }

    • Access Control

    The following capabilities are required to access this API: ReadProfile