Scopes
A credential can call an operation only if it holds the scopes that operation
lists. Otherwise the API answers 403 insufficient_scope, and details
names the missing scopes:
{ "error": { "code": "insufficient_scope", "message": "The credential does not have the scope this operation needs.", "request_id": "req_3f0c2a9d5b6e4f7a8c1d2e3f4a5b6c7d", "details": { "required_scopes": ["issues:triage"], "any_of": false } }}- You can put a scope on a key only if your role in the workspace allows the matching actions. Workspace owners can grant every scope.
- Scopes that return DAST results also need permission to run DAST scans.
- Starting a scan needs the scope for that scan type, such as
scans:code_executefor a code scan. - Subscribing a webhook to an event type needs that event’s read scope; see Webhooks.
| Scope | Grants | Operations |
|---|---|---|
workspace:read | Read the workspace profile, plan and integration status. | |
usage:read | Read plan limits and scan usage. | |
repos:read | List code repositories and container images. | |
scans:read | Read scans and scan history. | |
scans:code_execute | Start code scans (SAST, SCA, secrets, IaC). | |
scans:dast_execute | Start DAST scans against authorised targets. | |
scans:container_execute | Start container image scans. | |
scans:pentest_execute | Start pentests against approved targets. | |
issues:read | Read issues, issue counts and issue groups, including code snippets. | |
issues:triage | Resolve and reopen issues. | |
issues:exceptions | Request false-positive, snooze and risk-acceptance exceptions. A person approves them. | |
issues:export | Export issues as JSON or CSV. | |
autofix:read | Read autofix jobs, their patches and the remediation policy. | |
autofix:execute | Request AI autofix pull requests. | |
autofix:settings_write | Change the workspace remediation policy. | |
kubernetes:read | Read Kubernetes clusters, findings and images. | |
kubernetes:triage | Change the status of Kubernetes findings. | |
dast:read | List authorised DAST targets. | |
pentest:read | Read pentest targets and reports. | |
pentest:request_target | Request a pentest target. A person approves it. | |
teams:read | List teams and their repositories. | |
members:read | List workspace members, including email addresses. | |
audit:read | Read the workspace audit log. | |
reports:generate | Generate PDF reports. | |
webhooks:read | List webhook subscriptions and deliveries. | |
webhooks:manage | Create, change and delete webhook subscriptions. |