Role
A role is a set of rights/permissions assigned to users.
The REST API provides support for working with roles:
Create or Update a Role
Creates a new role or updates an existing one. Requires administrator privileges.
- URI
/api/v1/role - Method
POST - Headers
Authorization,Content-Type: application/json - Body
{ "name": "myRole", "permissions": [...set of permissions...] }name- the role’s name;permissions- optional, the set of role’s permissions;
-
Success response
Content-Type: application/json{ "result": "CREATED", "id": "..." }
Get a Role
Returns an existing role.
- URI
/api/v1/role/${name} - Method
GET - Headers
Authorization - Body none
- Success response
Content-Type: application/json{ "id": "...", "name": "...", "permissions": [...set of permissions...] }
Remove a Role
Deletes an existing role.
- URI
/api/v1/role/${name} - Method
DELETE - Headers
Authorization - Body none
-
Success response
Content-Type: application/json{ "result": "DELETED", "ok": true }
List Roles
List all existing roles.
- URI
/api/v1/role - Method
GET - Headers
Authorization - Body none
- Success response
Content-Type: application/json[ { "id": "...", "name": "...", "permissions": [...set of permissions...] } ]