How to access User and API keys management?
- The Management Console can be accessed via a web browser. Enter your Brain URL into the search bar and hit enter.
- Login with your credentials. In case your session is still valid, you won't need to Login again and go straight into Device Management.
- Select Admin Panel in the Menu to open the Administrator Panel.
Note: You'll need to be system administrator to be able to manage users and API keys.
This section allows you to manage users within Brain and can be accessed from the Admin Panel menu. Once selected, the interface returns a list of all the users in the system as illustrated by the figure below.
Admin and non Admin
There are two type of users: Admin and non Admin. The difference between these two types is that Admin users are allowed to create and delete other users and manage API keys, non Admin users can't. Also the Admin Panel option in the menu will only be available for Admin users.
Create a new user
Press the New user button located at the right side. This will open a new form dialog. Fill in all the details and confirm using the button Save Changes.
Edit user details
To change the Username, Admin mode, First or Last name, press the Pencil button located at the right side of the screen. Pressing this button puts this user in edit mode and allow you to change the details. To finish changes press the OK button. To cancel any changes or close edit mode press the revert button.
To change a password press the lock button. A form dialog will appear that allow you to enter a new password. Confirm you new password by pressing the Save Changes button.
Delete an existing user
To remove an user press the remove button located at the right side of the screen. A confirmation dialog will appear to confirm this change. After pressing OK the user will be removed from the system.
API key management
This section allows you to manage Application Programming Interface (API) keys within Brain and can be accessed from the Admin Panel menu. Once selected, the interface returns a list of API keys in the system as illustrated by the figure below.
Create a new API key
Press the New key button located at the top right side. This will open a new form dialog. Enter a label for this key and confirm using the button Save changes.
API key permissions
By default all keys have read and write permissions. This means that the application using this key can read, modify and remove data. If the application should not have have write access, you'll need to update permissions. Press the pencil button to enter edit mode and remove write permission. To save changes press the OK button.
Change API key label
To change the label of the API key, enter the edit mode by pressing the pencil button. To confirm changes press the OK button. To cancel changes press the revert button.
Delete API key
To delete/revoke an application from accessing your Brain simply remove the API key by pressing the remove button. A confirmation dialog will appear to confirm this change. After pressing OK this key will be removed from the system and can no longer be used to access the API.