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.

ScopeDescription
botEnables communication between a Repeater and the Bright engine
files:readAllows reading and download files from the storage
files:writeAllows to associate files with projects, clone files, upload or delete them
integration.repos:readAllows viewing associated repositories, for example, GitHub repositories, Slack channels, or Jira boards
issues:readAllows viewing detected scan issues
issues:manageAllows execution and saving scan issues as new
scans:deleteAllows deleting scans
scans:manageAllows editing scan settings
scans:readAllows viewing existing scans
scans:runAllows running and retesting scans
scans:stopAllows stopping scans
scripts:readAllows viewing repeater’s scripts
scripts:writeAllows creating, editing and deleting repeater’s scripts
repeaters:readAllows viewing organization’s repeaters
repeaters:writeAllows creating, editing, and deleting a repeater, as well as testing repeater connection to a network