| Cloud Admin | Enterprise Admin | User |
|---|---|---|
 |
 |
|
Contents:
Roles Resource offers the functionality of managing the platform roles in a logical way.
Role Data Model
| Field Name | Type | Occurs | Required | Description |
|---|---|---|---|---|
| name | String | 1 | true | The role's name. |
| description | String | 1 | true | The role's description |
| securityLevel | Decimal | 1 | true | The security level. See Role security levels to a detailed explanation |
Methods related to Role Resource
Retrieve a list of roles
Synopsis: GET http://example.com/api/admin/roles
Request Headers: Accept, Content-Type.
Request Parameters: N/A.
Request example: Retrieve all roles
Response Headers: Content-Length, Content-Type.
*Response Message Body: Enterprises
Response Status: 201, 400, 401, 403.
Response example: The creation response
Create a new role
Synopsis: POST http://example.com/api/admin/roles
Request Headers: Accept, Content-Type.
Request Parameters: N/A.
*Request Message Body: Role.
Request example: Create new Role
Response Headers: Content-Length, Content-Type.
*Response Message Body: Enterprise
Response Status: 201, 400, 401, 403.
Response example: The creation response
Retrieve a Role
Synopsis: GET http://example.com/api/admin/roles/{$roleId}
Request Headers: Accept, Content-Type.
*Request Parameters: N/A.
*Request Message Body: N/A.
Example Request: Retrieve information about a role.
Response Headers: Content-Length, Content-Type.
*Response Message Body: Enterprise.
Response Status: 200, 401, 403.
Example Response: Response of the GET over a role
Updates an existing role.
Synopsis: PUT http://example.com/api/admin/roles/{$roleId}
Request Headers: Accept, Content-Type.
Request Parameters: N/A.
*Request Message Body: Enterprise.
Example Request: Update information about a role.
Response Headers: Content-Length, Content-Type.
Response Message Body: N/A.
Response Status: 200, 400, 401, 403.
Example Response: Response of the update
Delete an existing role.
Synopsis: DELETE http://example.com/server/admin/roles/{$roleId}
Request Headers: Accept, Content-Type.
Request Parameters: N/A.
Request Message Body: N/A.
Example Request: Delete information about a role.
Response Headers: Content-Length, Content-Type.
Response Message Body: N/A.
Response Status: 204, 401, 403, 409
Example Response: Response of the deletion
