Users

Overview

This gives a quick overview about users, their roles, and permissions.

Adding a New User

1. To add a user, click + Add User.

Simple Mode

1. Enter the username, password and password confirmation in the Create User dialog. If needed, additional select any already existing Role in the Roles field if you want to assign the role to the user. Then click CREATE. The dialog will close and the new user will be visible in the overview table.

(The username and password must fulfill the noted criteria.)

Advanced Mode

To activate advanced mode, toggle the switch in the top right of the dialog.

1. Here you can additionally add individual permissions to the new user. To do so, click the + in the toolbar.

1. In the Add Permissions dialog select the type of permission you want to add.

Enter the resource path (both MQTT and HTTP follow MQTT topic conventions) and select the access type (read, write or both) the permission should be valid for. The specified topic can be either a single topic or a wildcard.

The resource path on HTTP permissions follow an MQTT topic structure. This means wildcards ( “#” and “+”) can be used for valid expressions and paths should start with a leading “slash”.

The assigned Additional Permissions can be either MQTT (for accessing the MQTT topics on the broker) or HTTP (for accessing the REST API using HTTP clients). Press the ADD button to add a permission.

However, the suggested way of assigning permissions is not to assign individual permissions in this dialog, but rather using roles, see Add Role to User below. Nevertheless sometimes it is useful to assign individual permissions, so these steps will be explained in the following.

1. When all permissions have been added, create the new user by clicking the CREATE button.

Editing Users

1. On the navigation panel, click User.

1. Click on the table row of the user you would like to edit.

Changing Passwords

1. Click on the Change Password button in the user detail view.

1. Type in the new password twice and click the UPDATE button in the dialog.

Adding Roles to Users

1. Click on the roles dropdown to open the options list.

1. Select Roles you want to add to the user by clicking on the options in the dropdown. They will be shown in the text field next to each other.

1. Save the changes by clicking the UPDATE button in the bottom right.

Deleting Roles from Users

1. Click on the x right next to the role name in the roles field to remove this role.

1. Save the changes by clicking the UPDATE button in the bottom right.

Adding Individual Permissions to Users

1. Toggle the Advanced mode switch in the top right of the dialog.

This will extend the dialog with an Additional permissions section.

1. Click the + in the new section to add individual permissions to the user.

1. In the Add Permissions dialog, select the type of permission you want to add.

Enter the resource path (both HTTP and MQTT follow MQTT topic structures) and select the access type (read, write or read and write for both) the permission should be valid for. The specified topic can be either a single topic or a wildcard.

The resource path on HTTP permission follow an MQTT topic structure. This means both wildcards ( “#” and “+”) are valid expressions and paths should start with a leading “slash”.

1. When all permissions have been added, update the user by clicking the UPDATE button.

Deleting Permissions from User

1. Toggle the Advanced mode switch in the top right of the dialog.

This will extend the dialog with an Additional permissions section.

1. Click the Remove button in the action column for the permission you want to remove.

1. The permission does no longer show in the Additional permissions section. Confirm the changes by clicking the UPDATE button.

Deleting Users

1. Click on the table row of the user you would like to delete.

1. Click the DELETE button in the top right of the user edit dialog.

1. Click the delete button in the dialog.