Staff Roles & Permissions

Give team members access to the admin area with only the permissions they need.

WemX uses roles to give people access to the admin area. A user who has at least one role counts as staff and can open /admin. What they can see and do there depends on the permissions in their roles.

Who has access

Account typeAccess
Primary administratorThe first account, created by the installer. It always has every permission and can't be restricted.
Super admin roleA role with All permissions enabled. Members have full access, like the primary admin.
StaffAny user with one or more roles. They have exactly the permissions their roles grant.
CustomerA user with no roles. They can only use the client area.

Staff are asked for their password again when they first open the admin area in a new session. If someone steals a customer-side session cookie, they still can't reach the admin panel with it.

Create a role

  1. Go to Admin → Staff Roles → Create.
  2. Enter a name and an optional description, for example Support Agent.
  3. Optionally choose a parent role. The new role inherits all of its parent's permissions, and you add extra ones on top. If the parent is a super admin role, the child is one too.
  4. Either turn on All permissions to make it a super admin role, or tick the individual permissions it needs.
  5. Save the role.

Assign a role to a user

Open the user under Admin → Customers, go to the Roles tab, and add the role. Only the primary admin and staff with the admin.users.manage_roles permission can assign roles. Give that permission to very few people, because anyone who has it can give themselves full access.

Your license plan may limit how many staff accounts you can have.

Permission reference

Dashboard

PermissionAllows
admin.dashboardOpen the admin dashboard
admin.dashboard.statisticsSee earnings, orders and other statistics
admin.dashboard.world_mapSee the customer location map
admin.dashboard.recent_ordersSee recent orders
admin.dashboard.recent_paymentsSee recent payments
admin.dashboard.online_usersSee who is online
admin.dashboard.application_logsSee application and scheduler logs

Customers & roles

PermissionAllows
admin.usersList customers
admin.users.viewView a customer's details
admin.users.createCreate customers
admin.users.updateEdit account details, address, password and sessions, and send emails
admin.users.deleteDelete customers
admin.users.impersonateLog in as a customer
admin.users.manage_rolesAssign and manage roles (high privilege)
admin.rolesList staff roles
admin.roles.createCreate roles
admin.roles.updateEdit roles and their permissions

Orders & payments

PermissionAllows
admin.ordersList orders
admin.orders.viewView an order
admin.orders.updateEdit order details
admin.orders.perform_actionsSuspend, unsuspend, terminate, extend, transfer and upgrade orders
admin.orders.deleteDelete orders
admin.paymentsList payments
admin.payments.viewView a payment and download its invoice
admin.payments.updateEdit payments
admin.payments.refundRefund payments
admin.payments.complete_manuallyMark unpaid payments as paid
admin.payments.deleteDelete payments

Content, email & data

PermissionAllows
admin.pages.index / .view / .create / .update / .deleteManage custom pages
admin.emails.indexView the sent email log
admin.emails.configureChange SMTP settings
admin.emails.templatesEdit email templates
admin.emails.mass-mailsSend mass emails
admin.data-exportDownload data exports (each dataset also needs its own area's permission)
admin.integrated-marketplaceBrowse and install from the marketplace
admin.settings.indexManage the license and run updates

Checkout

PermissionAllows
use-sandbox-gatewaysCheck out with sandbox (test) gateways

Extensions can add their own permissions. The Tickets module, for example, adds admin.tickets.* and admin.ticket-departments.* (see Tickets). They show up in the role editor automatically.

In the current beta, some admin sections aren't protected by a specific permission and are open to every staff member: Categories, Packages, Gateways, Servers, Currencies, Tax Countries, Settings, Images and Installed Extensions. Only give staff roles to people you trust with those areas.

On this page