How to manage Hyperglance users
This article desribes how to manage Hyperglance own internal database of users when not using SSO.
At the current time the internal database of users is managed by CLI. In the future it will be possible to manage users within the UI.
If you are running on our legacy Docker-based architecture, see legacy guide.
Default user:
By default Hyperglance comes loaded with a single admin user whose username is 'admin' and the initial password would be the instance-id, computer name or just 'admin' depending on how you deployed Hyperglance.
To get started see the scenario examples at the bottom of this page!
User Management Commands
Use the hg CLI tool to administer users:
ncludes tooling for managing users on a RKE2 based deployment of Hyperglance.
Usage:
hg users [flags]
hg users [command]
Available Commands:
add Add a new user to Hyperglance.
delete Delete a user from Hyperglance.
list List all the users in Hyperglance.
reset-password Reset a users password.
roles Set a users role/s. This command overwrites all existing roles with the provided comma separated list of roles.
Flags:
-h, --help help for users
hg users add
Adds a user to the database.
If no password is provided, a password prompt is shown. If no role is provided, the default role of HyperglanceUser is assumed.
Usage:
hg users add [flags]
Flags:
-h, --help help for add
-p, --password string The password to use. Setting this does not validate the password.
-r, --role string The roles to apply to this. Allowed options are: HyperglanceUser [default], HyperglanceContributor, HyperglanceAdmin or none. (default "HyperglanceUser")
-u, --username string The new users username.
hg users delete
Removes a user from the database.
Usage:
hg users delete [flags]
Flags:
-f, --force Force delete the user without verification
-h, --help help for delete
-u, --username string The users to be deleted.
hg users list
List all the users in Hyperglance.
Note: Only users with an active role assigned will be shown.
Usage:
hg users list [flags]
Flags:
-h, --help help for list
hg users reset-password
Changes the password of an existing user.
Usage:
hg users reset-password [flags]
Flags:
-h, --help help for reset-password
-p, --password string The password to use. Setting this does not validate the password.
-u, --username string The users username whose password is to be reset.
hg users roles
Assigns a set of roles to an existing user. This will entirely replace all roles previously assigned to the user with the new set of specified roles.
Learn more about how roles work in Hyperglance's RBAC system.
Usage:
hg users roles [flags]
Flags:
-h, --help help for roles
-r, --roles string The comma (,) separated roles to apply to this user.
-u, --username string The username to assign the roles to
Scenario Examples
Change the password of the default 'admin' user:
hg users reset-password -u admin
Add an additional admin user:
hg users add --username kirk --role HyperglanceAdmin
Add a user who can do everything except for administration duties:
hg users add --username spock --role HyperglanceContributor
Add a user who can only view 'dev1' and 'production1' accounts:
hg users add --username uhura
hg users roles --username uhura --roles HyperglanceUser,dev1,production1
Add a user who can view and trigger automations against (read/write) your 'dev2' account:
hg users add --username scotty
hg users roles --username scotty --roles HyperglanceUser,HyperglanceActionsUser,dev2