To access specific Bright CLI or API features, you need to have appropriate access scopes enabled for your user role or API key. Each scope allows the user to perform a specific action on a specific type of resource, for example, view, edit, or delete scans, files, or authentication objects.

Locating an API key settings

The Bright app has three levels of API keys: personal, project, and organization. The adjustment process is the same, with the only difference being that the settings are located in different places.

• To enter the personal API keys settings: open the Scans Tab → click in the upper-right corner of the Scans page → User Settings → scroll down to the Manage your user API keys block.
• To enter project API keys settings: open the Project Tab → click → choose the Settings → scroll down to the Manage your Project API keys block.
• To enter organization API keys settings: open the Organization Tab → scroll down to the Manage your Organization API keys block.

Creating an API key

To create an API key, do the following:

1. Go to the location you need depending on what kind of API key you want to create, and then click + Create API key.
2. Type the name of the key.
3. Set the expiration date if needed. To do that, click and then select the date in the pop-up calendar.

4. Select the scopes you want to manage using this API key. Use Select all and Deselect all buttons to manage the scopes quickly.
5. Once everything is ready, click the Create button to continue.
6. The unique key will appear.

Make sure you store it in a safe place because it is impossible to restore it.

Editing an API key

To edit an existing API key, click next to a particular item and select Edit. The same window will be opened, like during the creation of the API key. After changing the settings, click on Save to apply.

Deleting an API key

To delete an existing API key, click next to a particular item and select Delete. Then click YES to confirm.