Skip to content

User accounts

Each account in MultiTaction Canvus has a profile. Your profile contains information about you, such as name and password.

Administrators manage accounts in the admin area of the web UI (Admin > Users) or with the server's command-line user commands. See Admin web UI and Command-line arguments.

Creating users

You can create users:

  • Manually through the sign-in page
  • Manually in the admin area
  • Automatically through authentication integration

Create users on sign in page

If you have sign-up enabled, users can create their own accounts by registering on the sign-in page. Only email addresses in domains on the sign-up-allow-list can register. The user must confirm their address from an email before they can sign in, so self-registration needs email to be configured.

Create users in admin area

As an administrator, you can manually create users:

  1. Open Canvus server web UI
  2. Navigate to Admin > Users
  3. Press New user button
  4. Enter the name and email address. Tick Grant administrator access to make the user an administrator.
  5. Press Create user

What happens next depends on email:

  • Email configured: the server sends the user a password reset email so they can set their own password. If the email cannot be sent, the user is still created and the user list shows a warning.
  • Email not configured (from Canvus Server 26.10.4): the server assigns a random password and shows it to you once. Copy it and give it to the user securely. You cannot see it again after you close the message.

See Email (SMTP) setup.

Tip

You can also create users through the API as an administrator, or on the server with --create-user and --create-admin.

Create users through authentication integration

If you have set up single sign-on (Canvus Server 26.11.1 and later) and selected Allow new accounts in Admin > Authentication, Canvus creates an account the first time a person signs in with Sign in with Microsoft or another OpenID Connect provider.

When someone signs in with single sign-on for the first time, Canvus does the following, in this order:

  1. If the identity is already linked to a Canvus user, that user signs in.
  2. If a Canvus user already has the same e-mail address, Canvus links the identity to that user. No second account is created. Canvus compares e-mail addresses without regard to case.
  3. Otherwise Canvus creates a new regular user, if Allow new accounts is on and the e-mail domain is on the sign-up allow list. If admin approval is required, the account is not approved until an administrator approves it.

Single sign-on never makes a user an administrator. Make a user an administrator in Admin > Users. If a person registered with a password but never confirmed the e-mail address, their first single sign-on sign-in takes over that registration and removes the password.

Approving new accounts

When require-admin-approval is on (Admin > Settings > General > Require admin approval for new accounts), new accounts cannot sign in until an administrator approves them.

  1. Open Admin > Users.
  2. Choose the Pending filter. It lists accounts waiting for approval.
  3. Press Approve next to the account.

Blocking and unblocking users

Block an account to stop someone signing in without deleting their data.

  1. Open Admin > Users.
  2. Press Block next to the account and confirm. The user is signed out of all sessions and cannot sign in until unblocked.
  3. To restore access, choose the Blocked filter and press Unblock.

On the server, use --block-user and --unblock-user.

Resetting a password

  • In the admin area: press Reset pwd next to the user in Admin > Users, or Send password reset on the user's edit page. The server emails the user a reset link. Their current password stays valid until they choose a new one. This needs email to be configured.
  • On the server: run --change-password <email>. Without a password argument the command generates one and prints it. See Command-line arguments.

Users can change their own password in Profile.

Granting administrator access

  1. Open Admin > Users and press Edit next to the user.
  2. Tick or clear Grant administrator access.
  3. Press Save.

On the server, use --make-admin and --make-normal-user. The Admins filter in Admin > Users lists all administrators.

If no administrator can sign in, see How do I create a local emergency admin account from the CLI?.

Deleting users

Users can be deleted from Canvus by an administrator:

  1. Open Canvus server web UI
  2. Navigate to Admin > Users
  3. Press Delete on user account to delete

Warning

Deleting a user permanently removes the account and all of the user's non-shared resources. This cannot be undone.

Tip

You can also delete users through the API as an administrator, or on the server with --delete-user.

Built-in accounts

Every server has two built-in accounts. Nobody can sign in as either of them.

  • System: used by the server itself, for example when you run command-line user commands.
  • Guest: represents people who use the server without signing in. Guest is a member of the All Users group.

User groups

To simplify access management, you can create user groups and assign permissions to these groups.

Note

Only administrators can create and manage user groups.

Every server has a built-in group, All Users, described as "All users on this server". The Guest account is a member of it.

Creating a group

To create a new group:

  1. Sign in to the Canvus server web UI as an administrator
  2. Navigate to Admin > Groups
  3. Click New group
  4. Enter a name and, optionally, a description, then click Create group

Adding and removing members

  1. Navigate to Admin > Groups and click Edit on the group.
  2. Under Members, type a name or email address in Add user by name or email and click Add next to the user.
  3. To remove a member, click Remove next to their name.

Deleting a group

To delete a group:

  1. Sign in to the Canvus server web UI as an administrator
  2. Navigate to Admin > Groups
  3. Click Delete on the group you want to remove

Members lose access to anything the group granted them. This cannot be undone.