Skip to content

Permissions Reference

Complete list of all permissions registered across all core and optional modules.

Core modules

Auth

KeyDisplay NameDescription
user_createCreate new userAbility to create a new user
user_editEdit userAbility to edit an existing user
user_deleteDelete userAbility to delete a user
user_viewView userAbility to view user list

Permissions

KeyDisplay NameDescription
role_createCreate new rolesAbility to create roles
role_readRead rolesAbility to view roles
role_updateUpdate rolesAbility to edit roles
role_deleteDelete rolesAbility to delete roles
role_assignAssign rolesAbility to assign roles to users
permission_assignAssign permissionsAbility to assign direct permissions to users

Module

KeyDisplay NameDescription
module_manageManage modulesAbility to load or unload modules

Optional modules

KeyDisplay NameDescription
gallery_uploadUpload galleryAbility to upload media files
gallery_deleteDelete galleryAbility to delete media files

Logger

KeyDisplay NameDescription
logger_viewView logsAbility to view the logger bar and log entries

PageBuilder

KeyDisplay NameDescription
page_createCreate pageAbility to create new pages
page_editEdit pageAbility to edit existing pages
page_deleteDelete pageAbility to delete pages

Registering permissions in a module

Permissions are declared in the $permissions property of your service provider and automatically registered when the module boots:

php
protected array $permissions = [
    'my_permission' => [
        'name'        => 'Display name shown in UI',
        'description' => 'Description shown in UI',
    ],
];

TIP

Permission keys should follow the resource_action naming convention (e.g. post_create, post_delete) to stay consistent with the rest of the codebase.