Cyberlop names each permission as area:action. The area is a part of the product, like target, scan or issue. The action is what you may do there, like read, create or triage. Examples are target:create, scan:run and ci:trigger.
The short version
Every permission is a key with two parts joined by a colon, where the first part is the area and the second part is the action. So scan:run means you may run scans, and issue:triage means you may change an issue's status.
How it works in Cyberlop
Each API route in the API Reference shows its required permission on the right, and a role is simply a list of these keys, chosen by an admin. A few routes show public or authenticated instead, because anyone, or any signed-in user, may call them.
| Area | Actions seen |
|---|---|
target | read, create, delete |
profile | read, create, update, delete, manage_credentials |
scan | read, run, cancel, delete, read_report |
issue | read, triage, export |
schedule, group, tag | read, create, update, delete (tags: read, create, delete) |
ci | trigger |
activity | read, read_team, read_all |
user, role, team | read, manage |
settings | read, update |
Longer actions use an underscore, as in profile:manage_credentials and scan:read_report. The colon splits area from action, and the underscore only joins words.
Read keys let you look. Create, update and delete keys let you change things. Keys such as scan:run and issue:triage name a task, which can matter more than a plain write, since a scan costs money and a triage changes what your team sees.
What to do next
- Build a role from these keys with how to create a custom role.
- Look up what a call needs in how to find an endpoint's permission.
- See the built-in names in which roles come built in.
Granting few keys is least privilege. Not sure which key a task needs? Ask us through the contact page.
Related questions
- Which permissions can I give a custom role?
- How do I create a custom role with specific permissions?
- How do I find the endpoint I need and the permission it requires?
- Which roles come built in?
- Why does my API call return a permission error?
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.