How to register a role — Versola Docs
/docs
Pre-1.00.7.5versola.ioGitHub
RUEN

How to register a role

Create a role in the Versola admin console, choose the permissions it grants and assign it to users

A role is a named set of permissions that you assign to users per tenant. This page creates one in the admin console. For the fields and rules, see Role.

Prerequisites

1. Open Roles

Open Roles under the tenant. Each card shows the description, the role ID and an Inactive badge for a role that is switched off. Expand a card to see its permissions.

Roles of the selected tenant: the card title is the description, the ID is below it
Roles page with two roles.
An expanded role with its permissions
Role expanded to show its permissions.

2. Start a new role

Press + Create Role.

Create New Role: ID, description, Active and the permission list
Empty Create New Role form.

3. Fill in the role

  1. Role ID: lowercase letters, digits and hyphens, starting with a letter, for example auditor or payments-admin. Underscores are rejected, although the hint under the field mentions them. You cannot change the ID later.
  2. Description: required, in English.
  3. Active: leave it on so the role grants access at once. Switch it off to keep the role without letting it grant anything.
  4. Permissions: tick each permission the role grants. The i next to a permission lists the resources and endpoints it covers.
An auditor role with payments:read selected
Create New Role form filled in.

4. Create the role

Press Create Role. The role is ready to assign. Open the user, press Get Roles on the card for the right tenant and add the role. See How to register a user.

At request time edge unions the permissions of every role the user holds in the token’s tenant. The role IDs are copied into the token when it is issued, so a role you add or remove reaches the user’s next issued or refreshed token.

Edit or delete a role

Press the pencil on a card to change the description, the active state or the permissions. The ID cannot change. The cross deletes the role after a confirmation. Users keep the assignment, but the ID no longer maps to any permission. To retire a role and keep it, switch Active off instead.

Next steps