Skip to main content
Version: 0.6.0

Dashboard: Users & Roles

Routerly has a role-based access control (RBAC) system for the dashboard. Users are granted permissions via roles. Three built-in roles are provided; you can create additional custom roles with any combination of permissions.


Permissions​

PermissionDescription
router:readView all routers and their configuration (global: not limited by router membership)
router:writeCreate, edit, and delete routers
model:readView registered models
model:writeCreate, edit, and delete models
user:readView dashboard users
user:writeCreate, edit, and delete users, assign roles. You can only grant, edit or remove users and roles whose permissions you hold yourself; otherwise the action is refused with 403
report:readView usage analytics and request logs
settings:readView global settings
settings:writeChange global settings
notification:writeManage notification channels and rules
token:readView router tokens (the token list in router responses is hidden without token:read, token:write or router:write)
token:writeCreate, edit and revoke router tokens (also granted by router:write)
role:writeCreate, edit, and delete custom roles (also granted by user:write)
audit:readRead the audit log
modules:readView which modules are installed and enabled
modules:manageEnable and disable modules
connections:readView provider connections
connections:manageCreate, edit, and delete provider connections
resilience:readView retry, timeout, and fallback settings
resilience:manageChange retry, timeout, and fallback settings
profiles:readView routing profiles
profiles:manageCreate, edit, and delete routing profiles
optimizers:readView the optimizer catalog, samples, and previews
optimizers:manageChange a router's optimizer pipeline
experiments:readView experiments and their metrics
experiments:manageCreate, edit, and delete experiments, manage their tokens

Built-in Roles​

RolePermissions
adminAll permissions
operatorEverything except user:write, role:write, settings:write, audit:read, modules:manage, resilience:*
viewerrouter:read, model:read, report:read, settings:read, token:read, audit:read, modules:read, connections:read, profiles:read, optimizers:read, experiments:read

Managing Users​

Users list showing email, role badge, and action buttons

Adding a User​

  1. Open Users in the sidebar
  2. Click + New User
  3. Enter the email address, password, and assign a role
  4. Click Create

The new user can log in immediately.

Editing a User​

Click a row, or its Edit icon, to change the user's email, password, or role. With user:write missing the row is inert and the icon is hidden.

Removing a User​

Click the Delete icon and confirm. The user's session is invalidated immediately.


Custom Roles​

Roles page showing built-in roles and their permission badges

Custom roles let you define granular permission sets for specific team members.

Creating a Custom Role​

  1. Open Roles in the sidebar
  2. Click + New Role
  3. Give the role a name (e.g. billing_reviewer)
  4. Check the permissions this role should have
  5. Click Save

Custom roles can be assigned to users the same way as built-in roles.

Editing / Deleting a Custom Role​

Click Edit to change the role's permissions. Users with this role are affected immediately.

Click Delete to remove the role. Users who had this role will lose their dashboard access. Reassign them first.


Router-Level User Assignment​

Users can also be assigned to specific routers (from the router's Users tab). This limits their access to that router without changing their global role.


CLI Management​

# List all users
routerly user list

# Add a user
routerly user add --email [email protected] --role operator

# Remove a user
routerly user remove --email [email protected]

# List roles
routerly role list

# Add a custom role
routerly role add --name billing_reviewer --permissions report:read

# Remove a custom role
routerly role remove --name billing_reviewer