Tutorial

Part of a tutorial: Step 2 of 12 in Bring your team in safely

Open in tutorial
In this section · 3 articles

How roles and permissions work

A role is a named set of permissions, defined once for your whole Laramin. Who holds it, and where, is decided separately: everywhere, in one workspace or in one team. Access only ever adds up.

Applies to
Roles & Permissions 1.2 and later
Who can do this
Platform owner, Administrator
On this page

In short

A permission lets someone do one thing, such as Create User. A role is a named set of permissions, such as "Sales Manager". You define each role once, for your whole Laramin. Then you decide who holds it and where: everywhere, in one workspace, or in one team. What a person can do is everything their roles and direct permissions add up to in the place they're working. Nothing ever takes a permission away.

How it works

Roles are defined once

There's one "Sales Manager" role for your whole Laramin, not a copy per workspace or team. Change its permissions and the change reaches everyone who holds it, everywhere. If one business needs a different set, make a different role, such as "Regional Sales Manager".

You create and change roles on Roles and Permissions › Roles. See Create a role and assign permissions.

Assignments say where a role applies

Each time you give someone a role, you choose a scope:

ScopeThe role appliesWho can be given it
GlobalEverywhere, in every workspace and teamAnyone
A workspace, shown by its nameOnly while the person works in that workspaceActive members of the workspace
A team, shown by its nameOnly while the person works in that teamActive members of the team and of its workspace

For example, Ravi holds Sales Manager in the Chennai Sales team, Kumar holds it in Bangalore Sales, and Anand holds it globally. You give roles on Roles and Permissions › Access Assignments. See Give someone a role.

The Roles field on the Users form sets the same global roles. See Create a user.

Access only adds up

While someone works in a workspace and team, Laramin adds together:

  • their global roles,
  • their roles in that workspace,
  • their roles in that team,
  • and any permissions granted to them directly in those places.
Diagram of the Sales Manager role defined once and assigned to Anand globally, Ravi in Chennai Sales and Kumar in Bangalore Sales, with global, workspace, team and direct access adding up to effective access.

There's no "deny". A workspace or team role can only add to what someone can already do. To take something away, remove the role or permission that gives it, in the scope where it was given. The Effective access panel shows where each permission comes from. See See why someone can do something.

When the header's Workspace switcher is on All Workspaces, no single workspace is in force, so only global roles and global direct permissions apply.

Direct permissions are for exceptions

You can also give one person a single permission without a role. Use it for exceptional access. If several people need the same combination, create or change a role instead. See Grant a permission directly.

You can only hand out what you hold

  • Changing a role's permissions: you can only grant or revoke permissions that you hold globally, because a role applies everywhere. Cells you can't change are shown locked.
  • Granting a permission directly: you can only grant permissions you hold in that scope.
  • Giving a role: you can only give a role if you hold every permission it carries in that scope, because giving it grants all of them at once. Roles you can't give are listed, but can't be chosen.

Super admins pass every check, so none of these limits applies to them. Being a super admin is a switch on the user account, not a role. See Super admin vs Administrator.

Who can use Roles & Permissions

The module's own permissions decide who can open its screens:

PermissionKeyLets you
List Rolefeature.rbac.role.listSee the Roles list
Create Rolefeature.rbac.role.createCreate roles
Edit Rolefeature.rbac.role.editRename roles and change their permissions
Delete Rolefeature.rbac.role.deleteDelete roles
List Assignmentfeature.rbac.assignment.listSee who holds what, and Effective access
Edit Assignmentfeature.rbac.assignment.editGive and remove roles
Grant Permissions Directlyfeature.rbac.assignment.grantGive single permissions to one person
List Permission, List Permission Groupfeature.rbac.permission.list, feature.rbac.permission_group.listRead the Permissions and Permission Groups lists

The Administrator role includes none of them. Out of the box, only super admins can use Roles & Permissions. The screens are in the Platform Administration experience, under Roles and Permissions.

Creating, renaming and deleting roles, and changing their permissions, needs these permissions globally. Holding them only in one team or workspace isn't enough.

Permissions come from Laramin and its modules

Core and every module bring their own permissions, and add them when they're installed. You don't create permissions yourself. The Permissions and Permission Groups lists are for reading; only a super admin can change them. Keys follow one pattern, such as feature.core.user.edit. See Permission key reference.

When changes take effect

Saved changes to a role or to someone's assignments apply from that person's next request, usually their next click. They don't need to sign out.

How it relates to

Next steps