User Management

A user is a known identity with a associated set of data and/or administrative access permissions. It can be a person or a software/hardware agent.

Users are managed using the web-based interface of the Connectware. You can add or delete users, edit their permissions and change their the password.

You can also create or modify roles which help you organize and share a set of permissions with multiple users.

Note

Any user who desires to modify roles or users needs the admin role or corresponding permissions.

Create a user with permissions

  1. Press the + button in the toolbar to add a user.

    ../_images/users_add.png
  2. Enter the user name (5 characters minimium) and password in the Create User dialog and click CREATE.

    ../_images/users_create.png
  3. Click on the table row for the newly created user.

../_images/users_select.png
  1. In the Additional Permissions section select the type of permission you want to add. This can be either data (MQTT broker) or api (HTTP Routes) and press the + button. (data access)

../_images/users_select_type.png
  1. In the Add Permission dialog select the access type (read, write or readWrite) and enter in the resource path (both data and api follow MQTT topic structures) the permission should be valid for. The specified topic can be either a single topic or a wildcard.

../_images/users_add_permission.png

Important

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

  1. Press the SAVE button to persist the changes to the user.

../_images/users_save.png

Delete a user

  1. Go to the Users menu.

../_images/sidebar_2.png
  1. Click on the table row of the user you would like to delete.

../_images/users_select.png
  1. Click the delete action in the user detail view.

../_images/users_delete_button.png
  1. Click the confirm button in the dialog.

../_images/users_delete_dialog.png

Change user password

  1. Go to the Users menu.

../_images/sidebar_2.png
  1. Click on the table row of the user you would like to update.

../_images/users_select.png
  1. Click the update password action in the user detail view.

../_images/users_update_password_button.png
  1. Type in the new password twice and click the confirm button in the dialog.

../_images/users_update_password_dialog.png
  1. Press the SAVE button to persist the changes to the user.

../_images/users_save.png

Add role to user

  1. Go to the Users menu.

../_images/sidebar_2.png
  1. Click on the table row of the user you would like update.

../_images/users_select.png
  1. Click on the ROLES field. A list of available Roles should be displayed.

../_images/user_roles.png
  1. Click on the desired role.

../_images/users_roles_add.png
  1. Press the SAVE button to persist the changes for the user.

../_images/users_roles_save.png

Remove role from user

  1. Go to the Users menu.

../_images/sidebar_2.png
  1. Click on the table row of the user you would like update.

../_images/users_select.png
  1. Click on the X on the role you would like to remove.

../_images/users_roles_remove.png
  1. Press the SAVE button to persist the changes for the user.

../_images/users_roles_save.png

Create a role with permissions

  1. On the navigation panel click on User Management to expand the menu.

../_images/sidebar_1.png
  1. Go to the Roles menu.

../_images/roles_menu.png
  1. Press the + button in the toolbar to add a role.

    ../_images/roles_add.png
  2. Enter the role name in the Create Role dialog and click CREATE.

    ../_images/roles_add_dialog.png
  3. Click on the newly created role.

../_images/roles_select.png
  1. In the Permissions section select the type of permission you want to add. This can be either data (MQTT broker) or api (HTTP Routes) and press the + button. (data access)

../_images/roles_add_permission.png
  1. In the Add Permission dialog select the access type (read, write or readWrite) and enter in the resource path (both data and api follow mqtt topic structures) the permission should be valid for. The specified topic can be either a single topic or a wildcard.

../_images/roles_add_permission_dialog.png
  1. Press the SAVE button to persist the changes for the role.

../_images/roles_save.png

Delete role

  1. Go to the Roles menu.

../_images/roles_menu.png
  1. Click on the table row of the role you would like to delete.

../_images/roles_select.png
  1. Click the delete action in the role detail view.

../_images/roles_delete_button.png
  1. Click the confirm button in the dialog.

../_images/roles_delete_dialog.png

MQTT users

The credentials of a User with grant type password can be used with an MQTT client to connect, subscribe and/or publish. . Subscriptions are possible on the associated readable topics (marked as read), whereas the associated data write permissions define the topics available for publishing (marked as write).

API Definition

Auth Server Swagger