In this section · 14 articles

Permission key reference

How Laramin permission keys are named, and every Core key for users, workspaces, teams and experiences, with whether the Administrator role includes it.

Applies to
Core 12.0 and later
Who can do this
Administrator, Platform owner, Developer
On this page

Roles are made of permissions, and each permission has a key. You give and take away permissions in the Roles & Permissions module. See How roles and permissions work. This page explains how the keys are named and lists Core's keys for this category. Super admins pass every check, so they don't need any of these keys.

How keys are named

Plain text
feature.<module>.<resource>.<action>     records, e.g. feature.core.user.edit
feature.<module>.<section>.view|edit     settings sections, e.g. feature.core.company.edit
feature.<module>.<experience>.enter      entering an experience, e.g. feature.core.admin.enter

Replace the highlighted values with your own.

PartMeaning
<module>The module's short permission name. Core uses core. Modules use their own, for example pcrm for Property CRM.
<resource>What the permission is about, in lowercase with underscores, e.g. user, workspace_member.
<action>What it allows. See the table below.
ActionAllowsIn the Administrator role?
listSeeing the listYes
viewOpening one recordYes
createAdding recordsYes
editChanging recordsYes
deleteDeleting records. Where there's a recycle bin, they go thereYes
restoreBringing records back from the recycle binYes
removeDeleting records foreverNo
bulk_<verb>, e.g. bulk_deleteAn action on many records at oncebulk_delete isn't. Others are
<verb>, e.g. approve, sendA task specific to the resourceYes, unless excluded below
<action>_own, e.g. edit_ownThe action, but only on records you ownYes

Two older Core keys don't follow the pattern: user.reset_password and user.set_password.

Users

KeyLabelIn the Administrator role?
feature.core.user.listList UserYes
feature.core.user.viewView UserYes
feature.core.user.createCreate UserYes
feature.core.user.editEdit UserYes
feature.core.user.deleteDelete UserYes
feature.core.user.restoreRestore UserYes
feature.core.user.removePermanently Delete UserNo
feature.core.user.impersonateSign in as another userNo
user.reset_passwordReset User Password (send reset link)No
user.set_passwordSet User Password (admin-typed)No

Workspaces and teams

Each of these resources has all seven actions: list, view, create, edit, delete, restore and remove. The Administrator role includes every action except remove.

Key prefixLabelsCovers
feature.core.workspace.List Workspace … Permanently Delete WorkspaceThe workspaces themselves
feature.core.workspace_member.List Workspace Member … Permanently Delete Workspace MemberWho belongs to each workspace
feature.core.team.List Team … Permanently Delete TeamThe teams themselves
feature.core.team_member.List Team Member … Permanently Delete Team MemberWho belongs to each team

Switching workspace or team has no permission. Being a member is what lets you in.

Experiences

KeyLabelIn the Administrator role?
feature.core.super_admin.enterEnter Platform AdministrationNo
feature.core.admin.enterEnter AdministrationNo
feature.core.experience.listList ExperiencesNo
feature.core.experience.viewView ExperienceNo
feature.core.experience.editEdit Experience PresentationNo

The Administrator role leaves out every permission in the experiences group. This includes the door keys that modules add, such as feature.pcrm.workspace.enter. You usually give the door keys per person on the Users form's Access step rather than through a role. Switching experience has no permission.

Settings sections

Each Core settings section has a view key and an edit key: feature.core.<section>.view and feature.core.<section>.edit. The same keys control the section on a workspace's own Settings screen.

SectionsIn the Administrator role?
system, company, theme, cookies, maintenance_mode, uploads, captcha, gdpr, mapsYes
security, monitoring, search, home_page, help_portalNo
cache, queue, session, storage, cdn, logging, broadcastingNo

The Help Center

KeyLabelIn the Administrator role?
feature.core.help.viewOpen the Help CenterYes. In 12.7 it was also given to every role that already existed. Roles created later don't get it automatically
feature.core.help_portal.view / .editView / Edit Help Center (the settings panel)No

A module whose docs are private declares its own key, feature.<module>.help.view, for reading them in the Help Center. The Administrator role has these keys.

Other keys the Administrator role leaves out

KeysWhy they're left out
feature.rbac.…Editing roles and permissions
developer.settings.…Infrastructure settings
feature.core.addon.…Installing, upgrading and removing modules
feature.core.trusted_device.…The trusted devices audit across all users
feature.core.deletion_request.…The account deletion request queue
any key ending .change_slugChanging a record's permanent web address

A module can also keep its own permissions out of the Administrator role.