Skip to content

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_execute for a code scan.
  • Subscribing a webhook to an event type needs that event’s read scope; see Webhooks.
ScopeGrantsOperations
workspace:readRead the workspace profile, plan and integration status.
usage:readRead plan limits and scan usage.
repos:readList code repositories and container images.
scans:readRead scans and scan history.
scans:code_executeStart code scans (SAST, SCA, secrets, IaC).
scans:dast_executeStart DAST scans against authorised targets.
scans:container_executeStart container image scans.
scans:pentest_executeStart pentests against approved targets.
issues:readRead issues, issue counts and issue groups, including code snippets.
issues:triageResolve and reopen issues.
issues:exceptionsRequest false-positive, snooze and risk-acceptance exceptions. A person approves them.
issues:exportExport issues as JSON or CSV.
autofix:readRead autofix jobs, their patches and the remediation policy.
autofix:executeRequest AI autofix pull requests.
autofix:settings_writeChange the workspace remediation policy.
kubernetes:readRead Kubernetes clusters, findings and images.
kubernetes:triageChange the status of Kubernetes findings.
dast:readList authorised DAST targets.
pentest:readRead pentest targets and reports.
pentest:request_targetRequest a pentest target. A person approves it.
teams:readList teams and their repositories.
members:readList workspace members, including email addresses.
audit:readRead the workspace audit log.
reports:generateGenerate PDF reports.
webhooks:readList webhook subscriptions and deliveries.
webhooks:manageCreate, change and delete webhook subscriptions.