Project API Key Scopes

When creating an API key in the project settings, you can predefine access permissions for that key by selecting the relative scopes. The following table describes the permissions that each scope provides.

Scope	Description
`auth-objects:read`	Allows viewing authentication objects
`auth-objects:test`	Allows testing an authentication object during its configuration
`auth-objects:write`	Allows creating, editing, and deleting authentication objects
`bot`	Enables communication between a Repeater and the Bright engine
`discoveries`	Provides unrestricted access to discoveries
`discoveries:read`	Allows viewing existing discoveries
`entry-points`	Provides unrestricted access to entry points
`entry-points:manage`	Allows creating, editing, deleting, testing and previewing changes made to entrypoints
`entry-points:read`	Allows viewing entry points
`files:read`	Allows reading and downloading files from the storage
`files:write`	Allows to associate files with projects, clone files, upload or delete them
`integration.repos:read`	Allows viewing resources of the integrated services, for example, GitHub repositories, Slack channels, or Jira boards
`issues:manage`	Allows execution and saving scan issues as new
`issues:read`	Allows viewing detected scan issues
`projects-issues:write`	Allows users to manage project issues: to change severity, status, and assignee
`projects:edit`	Allows editing project name, number of concurrent scans, adding associated GitHub or Gitlab repositories, Slack channels, Azure or Jira boards, managing webhooks
`projects:read`	Allows viewing of available projects and project issues. This scope is required for running a scan
`repeaters:read`	Allows viewing organization’s repeaters
`repeaters:write`	Allows creating, editing, and deleting a repeater, as well as testing repeater connection to a network
`scan-labels:manage`	Allows editing labels in scans that are already running or have been finished
`scans`	Provides unrestricted access to scan management. org:read scope is also required to run and manage scans
`scans:delete`	Allows deleting scans
`scans:manage`	Allows editing scan settings
`scans:read`	Allows viewing existing scans
`scans:run`	Allows running and retesting scans
`scans:stop`	Allows stopping scans
`scripts:read`	Allows viewing repeater’s scripts
`scripts:write`	Allows creating, editing, and deleting repeater’s scripts