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.

Body

  {
    "name": "myRole",
    "permissions": [...set of permissions...]
  }

Success response

  Content-Type: application/json

  {
    "result": "CREATED",
    "id": "..."
  }

Returns an existing role.

Success response

  Content-Type: application/json

  {
    "id": "...",
    "name": "...",
    "permissions": [...set of permissions...]
  }

Deletes an existing role.

Success response

  Content-Type: application/json

  {
    "result": "DELETED",
    "ok": true
  }

List all existing roles.

Success response

  Content-Type: application/json

  [
    {
      "id": "...",
      "name": "...",
      "permissions": [...set of permissions...] 
    }
  ]

Add or Remove LDAP groups to a Role. Requires administrator privileges.

URI /api/v1/role/${roleName}/ldapGroups?replace=${replace}
Query parameters
- replace: boolean, replace existing ldap groups mapped to a role, default is false;
Method PUT
Headers Authorization, Content-Type: application/json
Body
```
  ["group1", "group2",...]
```

Success response

  Content-Type: application/json

  {
      "result": "UPDATED",
      "ok": true
  }

List LDAP groups for a role.

Success response

  Content-Type: application/json

  [
      "group1", "group2", ...
  ]