The settings screen can be accessed through the icon. The following sections describe the functionality provided under this menu.
The User Management screen provide options to configure users.
New users can be added or invited by clicking the '+' icon in the bottom-right of the screen.
Completing this information will generate an invite link and send an email (if provided) to the supplied address.
SquareOne Companion uses a system of roles and permissions to control what functionality each user has access to. User roles currently comprise:
- Read Only A standard user account but with read only permissions.
- User A standard user account with no admin functionality.
- Admin A tenant level admin, contains all permissions for actions for specific tenants.
- Remote User A standard user account with the ability to VNC and use interactive terminal
- Lambda Developer User A user account with the ability to manage and develop lambdas
- Package Developer User A user account with the ability to mange and develop packages
Each user role has a corresponding set of permissions associated with it. For example, the read only role has permissions that allow such users to view various aspects of the system, such as assets, groups, and files, but do not have permissions that allow them to create new users or deploy artifact versions to assets.
Users can have multiple roles, or later be assigned no roles to prevent access to the system. Having multiple roles may be useful for users who by default should not have access to admin functionality but may wish to ascend to a higher privilege for carrying out certain tasks.
For users with multiple roles, the Default Role field is used to select which role they will have access to by default on login. Note that the default role for a user may or may not be the highest privilege role.
Users with multiple roles have a Switch Role option that allows them to freely change between their assigned roles at any time.
It is possible to view a user’s roles and default role by going to the Settings menu, choosing Users, and selecting from the list presented.
The Device Types screen provide options to configure logical device types (e.g. for different hardware models or use cases).
New device types can be added by clicking the icon in the bottom-right of the screen.
During device type creation, it is possible to override the port used for screen sharing functionality.
The Health Indicator screen provides an interface to adjust the global health indicators.
The Pending Devices screen provides options to inspect and approve (or disapprove/ban) devices that require manual approval (see Device Approval)
The Banned Devices screen provides options to view and remove device bans.
The Notification Types screen provide options to manage notification types.
The Notification Subscriptions screen provides the ability to subscribe to notifications by email or within the Companion UI.
The Lambda page provides an interface to manage custom code operation. For more information, see SquareOne Customization