Token Management

Overview

As part of the installation process of Sealights, users are required to use token. To date, there are three types of tokens:

• Agent Token - Used to configure agents reporting data to Sealights or in public APIs related to agents, such as downloading an agent or reporting test results.

• Browser Extention Token - Being used with the Sealights Chrome extension.

• API Token - Being used with our public APIs, apart from the APIs related to data from the agents.

Creating An Agent Token

Creating an Agent Token requires a DevOps user role. Please refer to the Onboarding Permissions page to verify that you have the right permissions.

1. Go to the settings page. This can be done by clicking on the cog icon () in the top right corner of the screen (next to your user's avatar).
2. Go to the Cockpit & Onboarding section in the menu and click Agent Tokens.

3. In the Agent Tokens screen, click on the Create New Token button. Make sure to click on the button and not on the text. This will allow you to input a new name for the token.

4. Name the token. As tokens are shared across the organization, name them in a descriptive name and click on Save.

5. If successful, the token will be added to the list of tokens. In addition, an "Agent token created and copied to the clipboard successfully" message will appear at the bottom of the screen.

Video Walkthrough: Creating a new token

An Agent Token can be passed as a parameter to Sealights agent in three ways: as a file, as a hard-coded value, or via an environment variable (usually via a Credential Manager).

You're free to select the convenient option for your configuration, but, in this documentation, we'll most of the time refer to the file option for simplicity and readability.

Creating A Browser Extention Token

Creating a Browser Extention Token doesn't require special permissions. All user types can create them.

In order to create a Browser Extention Token, follow the following steps:

1. Go to the settings page. This can be done by clicking on the cog icon () in the top right corner of the screen (next to your user's avatar).
2. Go to the Integration section in the menu and click Browser Extension Tokens.

3. In the Browser Extension Tokens screen, click on the Create New Token button. Make sure to click on the button and not on the text. This will allow you to input a new name fo the token.

4. Name the token. As tokens are shared across the organization, name them in a descriptive name and click on Save.

5. If successful, the token will be added to the list of tokens. In addition, an "Agent token created and copied to the clipboard successfully" message will appear in the bottom of the screen.

Creating An API Token

Creating an API Token requires DevOps or Admin user role. Please refer to the Onboarding Permissions page to verify that you have the right permissions.

In order to create an API Token, follow the following steps:

1. Go to the settings page. This can be done by clicking on the cog icon () in the top right corner of the screen (next to your user's avatar).
2. Go to the Integration section in the menu and click API Tokens.

3. In the API Tokens screen, click on the Create New Token button. Make sure to click on the button and not on the text. This will allow you to input a new name fo the token.

4. Name the token. As tokens are shared across the organization, name them in a descriptive name and click on Save.

5. If successful, the token will be added to the list of tokens. In addition, an "Agent token created and copied to the clipboard successfully" message will appear at the bottom of the screen.

Download a Token

Press the 'Download' button for the token you have selected (or just created), and a file called sltoken.txt will be downloaded to your computer. Copy it to the location you want to use it.

Alternatively, you could press the 'Copy' button and paste the token through the clipboard into the file and location you want or to any variable or credential manager tool.