Home / Help centre / Team & access
Team & access
How do I create a custom role with specific permissions?
Create a custom role in Administration, under Roles. Name it, then choose permission keys in the area:action format, such as scan:run or issue:triage. Save, then assign the role to users. You cannot change the built-in SuperAdmin role.
Steps
- Use an account with
role:manage, such as a SuperAdmin. - Open Administration and go to the roles section, then start a new role with the add control.
- Give it a name that says what the role is for, such as the Pro Dev example visible in the Activity feed.
- Choose the permissions. Start with the smallest set that lets the person do the job, and add more only when a real task fails for lack of one.
- Save.
- Assign the role to a user. Then open Activity, where a Create · Role entry lists every permission you chose, so you can check your work.
The Administration screens were not part of the pages we reviewed, so button names may differ. Treat the steps as a guide to the order of work, and trust what your screen shows over our wording.
Good to know
A role is a list of permission keys, and each key reads area:action. For developers who run scans and triage findings, a role might hold these:
| Need | Keys to include |
|---|---|
| See targets and profiles | target:read, profile:read |
| Run and read scans | scan:run, scan:read, scan:read_report |
| Work on findings | issue:read, issue:triage, issue:export |
| Trigger from CI | ci:trigger |
- The API has the same job.
POST /api/rolescreates a role, andPUT /api/roles/:idupdates one. - The SuperAdmin name is reserved, you cannot edit that role, and you cannot delete the system roles.
- Roles describe what a person may do. Teams and groups help set what they may reach.
See how permissions are named and which permissions a custom role can hold. This is role-based access control, so keep each role narrow.
Related questions
- How are permissions named?
- Which permissions can I give a custom role?
- Which roles come built in?
- How do I add a new user to my workspace?
- Why can't I edit or delete the SuperAdmin role?
Cyberlop API tokens and permissions: how to issue and limit them
Step-by-step, with annotated screenshots.
Updated · Back to the help centre
Still stuck?
Tell us what you see on screen and an engineer will help you sort it out.