4 Roles
4.1 Get Roles
GET https://<HOST>:<PORT>/api/roles/get?version=0
Returns all congigured roles.
Required Permissions
-
API
-
User Management Read Access
Response Body Structure
The response body is structured as Role JSON object. A description for its fields is at section 30.4.1. For the JSON schema refer to section 30.4.2.
Example
4.2 Add Role
PUT https://<HOST>:<PORT>/api/roles/add?version=0
Adds a new role
Required Permissions
-
User Management Read/Write Access
Request Body Structure
The request body is structured as Role JSON object. A description for its fields is at section 30.4.1. For the JSON schema refer to section 30.4.2.
Response Body Structure
The response body is structured as Role JSON object. A description for its fields is at section 30.4.1. For the JSON schema refer to section 30.4.2.
Example
4.3 Remove role
DELETE https://<HOST>:<PORT>/api/roles/remove?version=0
Remove an existing role.
Required Permissions
-
User Management Read/Write Access
Request parameters
-
role
The id or displayname of the role to be removed.