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

The following operations are supported on this resource:

  • GET - Get a single role from a remote profile
  • DELETE - Delete a role from a remote profile
GET /profiles/{id}/roles/{rid} Version 1

This API retrieves a specific role from a particular remote profile.

Sample Usage

GET /profiles/{id}/roles/{rid}


  • Parameters:
    Name Type URI Type Description Required
    id int Path The ID of the profile from which to retrieve the specified role. Y
    rid int Path The ID of the role to retrieve from the profile. Y
  • Sample Output XML:
    <role key="65696" uri="/api/space/user-management/profiles/458785/roles/65696"
         href="/api/space/user-management/roles/65696">
        <name>userAdmin</name>
        <title>User Administrator</title>
    </role>

  • Sample Output JSON:
    {
      "role":{
           "@key":"65696",
           "@uri": "/api/space/user-management/profiles/458785/roles/65696",
           "@href": "/api/space/user-management/roles/65696",
           "name":"userAdmin",
           "title":"User Administrator"
      }
    }

  • Access Control

    The following capabilities are required to access this API: ReadProfile

    DELETE /profiles/{id}/roles/{rid} Version 1

    This API deletes a specific role from a particular remote profile.

    Sample Usage

    DELETE /profiles/{id}/roles/{rid}


    • Parameters:
      Name Type URI Type Description Required
      id int Path The ID of the profile from which to delete the role. Y
      rid int Path The ID of the role to delete from the profile. Y

    Access Control

    The following capabilities are required to access this API: DeleteProfile