/{version}/roles/{roleId}
The following operations are supported on this resource:
Displays the XML representation of a specified role.
Parameters
name |
description |
type |
default |
roleId |
The role ID of the role you would like to display.
|
path |
|
Output Payload
element |
produceable content type(s) |
role (XML)
|
|
description |
The system returns a response that includes the XML representation of the role. |
Updates a security role in the system.
When updating a role, you must specify the name of the role you want to update. This value may stay the same, or
it may be modified. Each role must have a unique name.
You must also specify a list of all permissions that should be assigned to the role. If any
currently assigned permissions are excluded, they will be removed from the role. Likewise, any permissions in
the list that are not currently assigned to the role will be added.
While the XML will allow you to submit a list of researchers, you may not actually assign a role to a user with
this end-point. Any researchers provided in the XML will be ignored.
An example of a <role> PUT is as follows:
<role:role xmlns:role="http://genologics.com/ri/role">
<name>Existing Role Name</name>
<permissions>
<permission uri="http://localhost:8080/api/v2/permissions/10"/>
<permission uri="http://localhost:8080/api/v2/permissions/11"/>
</permissions>
</role:role>
Parameters
name |
description |
type |
default |
roleId |
The ID of the role you would like to update.
|
path |
|
Input Payload
element |
consumeable content type(s) |
role (XML)
|
|
description |
The information about the role you would like to update. |
Output Payload
element |
produceable content type(s) |
role (XML)
|
|
description |
When the role is successfully updated, the system returns an HTTP 200 (OK) code with a response body that includes the
updated attributes of the role. |