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
Couldn't copy. Select the code and press Ctrl+C (⌘+C on a Mac).
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.enterReplace the highlighted values with your own.
| Part | Meaning |
|---|---|
<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. |
| Action | Allows | In the Administrator role? |
|---|---|---|
list | Seeing the list | Yes |
view | Opening one record | Yes |
create | Adding records | Yes |
edit | Changing records | Yes |
delete | Deleting records. Where there's a recycle bin, they go there | Yes |
restore | Bringing records back from the recycle bin | Yes |
remove | Deleting records forever | No |
bulk_<verb>, e.g. bulk_delete | An action on many records at once | bulk_delete isn't. Others are |
<verb>, e.g. approve, send | A task specific to the resource | Yes, unless excluded below |
<action>_own, e.g. edit_own | The action, but only on records you own | Yes |
Two older Core keys don't follow the pattern: user. and user..
Users
| Key | Label | In the Administrator role? |
|---|---|---|
feature. | List User | Yes |
feature. | View User | Yes |
feature. | Create User | Yes |
feature. | Edit User | Yes |
feature. | Delete User | Yes |
feature. | Restore User | Yes |
feature. | Permanently Delete User | No |
feature. | Sign in as another user | No |
user. | Reset User Password (send reset link) | No |
user. | Set 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 prefix | Labels | Covers |
|---|---|---|
feature. | List Workspace … Permanently Delete Workspace | The workspaces themselves |
feature. | List Workspace Member … Permanently Delete Workspace Member | Who belongs to each workspace |
feature. | List Team … Permanently Delete Team | The teams themselves |
feature. | List Team Member … Permanently Delete Team Member | Who belongs to each team |
Switching workspace or team has no permission. Being a member is what lets you in.
Experiences
| Key | Label | In the Administrator role? |
|---|---|---|
feature. | Enter Platform Administration | No |
feature. | Enter Administration | No |
feature. | List Experiences | No |
feature. | View Experience | No |
feature. | Edit Experience Presentation | No |
The Administrator role leaves out every permission in the experiences group. This includes the door keys that modules add, such as feature.. 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. and feature.. The same keys control the section on a workspace's own Settings screen.
| Sections | In the Administrator role? |
|---|---|
system, company, theme, cookies, maintenance_mode, uploads, captcha, gdpr, maps | Yes |
security, monitoring, search, home_page, help_portal | No |
cache, queue, session, storage, cdn, logging, broadcasting | No |
The Help Center
| Key | Label | In the Administrator role? |
|---|---|---|
feature. | Open the Help Center | Yes. In 12.7 it was also given to every role that already existed. Roles created later don't get it automatically |
feature. / .edit | View / Edit Help Center (the settings panel) | No |
A module whose docs are private declares its own key, feature., for reading them in the Help Center. The Administrator role has these keys.
Other keys the Administrator role leaves out
| Keys | Why they're left out |
|---|---|
feature.rbac.… | Editing roles and permissions |
developer. | Infrastructure settings |
feature. | Installing, upgrading and removing modules |
feature. | The trusted devices audit across all users |
feature. | The account deletion request queue |
any key ending .change_slug | Changing a record's permanent web address |
A module can also keep its own permissions out of the Administrator role.
Thanks. That helps us decide what to write next.
Thanks for telling us what was missing.
You already answered for this article today. Thanks.
We got a lot of answers from your network just now. Try again in a few minutes.
We couldn't send that. Check your connection and try again.
Links in this article
Printed from help.bsscn.com. The online article may have changed since.