Roles

The following resources are applicable:

/roles

Mount Point: /v2/roles

GET

Returns the list of all the Roles associated to the account of the currently connected user.

Response Body

element: rolesResult
media types: application/xml
application/json

The list of requested Role objects.

POST

Creates a new Role based on the information provided in RoleCreator parameter.

Request Body

element: roleCreator
media types: application/xml

Provides the information for the new Role to be created.

Response Body

element: role
media types: application/xml

The newly created Role object.

/roles/{roleId}

Mount Point: /v2/roles/{roleId}

The following operations are supported on this resource:

GET

Returns the Role specified by the "id" path parameter.

Parameters

name description type default
roleId The id of the Role requested. path

Response Body

element: role
media types: application/xml
application/json

The requested Role object.

PUT

Updates the Role specified by the "id" path parameter based on the information provided in the Role parameter.

Parameters

name description type default
roleId The id of the Role to be updated. path

Request Body

element: role
media types: application/xml

(no documentation provided)

Response Body

element: role
media types: application/xml

The updated role.

DELETE

Deletes the Role specified by the "id" path parameter.

Parameters

name description type default
roleId The id of the Role to be deleted. path

/roles/administrator

Mount Point: /v2/roles/administrator

GET

Returns the Administrator Role for the current account.

Response Body

element: role
media types: application/xml
application/json

The requested Administrator Role object.