LogoLogo
Product
  • Knowledge Base
  • What's New
  • Guides
  • Welcome!
  • Intro to SeaLights
    • What is SeaLights
      • Glossary
      • Working in Conjunction with Your Quality / Coverage Tools
        • SeaLights vs SonarQube
        • SeaLights vs JaCoCo
    • Technical Overview
      • Test Stage Cycle
    • FAQ
  • User Story Coverage
    • Getting Started
    • User Story Challenges & Solution
      • Typical Implementation
      • The Challenges
      • The Solution
    • User Story Coverage Report Overview
      • Release Go / No Go Report
        • How to Generate / Edit the Report
      • User Story Quality Overview
        • How to Generate the User Story View
      • User Story Coverage Analysis
        • How to Generate the Analysis View
      • Uncovered Methods View
        • How to Generate the View
      • Customization
      • Integration
    • Use Cases by Persona
      • Managers
        • Informed Go/No Go Decisions Making
        • Effective Resources Prioritization
        • Overall Progress Monitoring
      • Developers
        • Code Quality Ownership
        • Seamless Collaboration with QA
        • Code Review Facilitator
      • QA Engineers
        • Test Execution Progress Monitoring
        • Testing Effort Prioritization
        • Testing Strategy Planing
    • Technical Overview
      • User Story Coverage Mechanism
      • Technical Architecture
      • Deployment Guide
        • US1_getResults.sh
        • US2_createReport.sh
        • US_UpdateConfluence.sh
  • Test Optimization
    • Getting Started
    • Test Execution Challenges & Solution
      • The Challenges
      • Test Optimization Solution
      • Test Optimization Main Advantages
    • Test Optimization Overview
      • Automated Test Optimization
      • Manual Test Optimization
      • Test Optimization for Pull Request
      • Test Selection Policies
        • Full Run Policy
        • No Code Changes Policy
        • Common Code Policy
        • Fastest Path to 100% Coverage Policy
      • Integrations
    • Use Cases by Persona
      • Managers
        • Fast Delivery
        • Resource Optimization
        • Thorough Testing in Tight Schedule
      • Developers
        • Exploring Only Relevant Test Failures
        • Faster Feedback Loop
        • Shift Left Testing
      • QA Engineers & Manual Testers
        • Faster & Focused Manual Testing
        • Optimizing Test Suite
        • Having Stable Product for Testing
    • Technical Overview
      • Test Optimization Mechanism
        • Associating Code With Tests
          • Statistical modeling
          • One-to-One Mapping
          • Calibration
        • Detecting Modified Code
        • Generating Test Recommendations
      • Technical Architecture
      • Deployment Guide
  • Quality Improvement
    • Getting Started
    • Challenges & Approach Comparison
      • The Challenges
      • Quality Improvement Approaches
      • Choosing the Right Approach
    • Quality Improvement Solution Overview
      • Test Gaps Analysis Report
        • How to Generate / Edit the Report
      • Coverage Trend Report
        • How to Generate / Edit the Report
      • Proof of Testing Report
        • How to Generate / Edit the Report
      • Release Quality Improvement Guide
        • STEP 1: Deploy SeaLights
        • STEP 2: Take a Quality Snapshot
        • STEP 3: Prioritize Code Areas
          • Add Code Labels
          • Ignore Irrelevant Code
          • Perform a Deep CSV Analysis
        • STEP 4: Set Baseline & Threshold
        • STEP 5: Analyze Test Gaps
        • STEP 6: Write Tests
        • Step 7: Make a Go / No Go Decision Based on Quality Gate
        • STEP 8: Measure Defect Escape Rate
      • Over Time Quality Improvement Guide
        • STEP 1: Deploy SeaLights
        • STEP 2: Take a Quality Snapshot
        • STEP 3: Prioritize code areas
          • Add Code Labels
          • Ignore Irrelevant Code
          • Perform a Deep CSV Analysis
        • STEP 4: Set Baseline & Goal
        • STEP 5: Set timeline
        • STEP 6: Write tests
        • STEP 7: Monitor progress
        • STEP 8: Measure Defect Escape Rate
    • Use Cases by Persona
      • Managers
        • Effective Prioritization & Budget Allocation
        • Tracking Progress & Measuring Impact
        • Data-Driven Release Decisions
        • Transparency & Communication
      • Developers
        • Mastering Code Coverage
        • Seamless Collaboration with QA
        • Code Quality Ownership
      • QA Engineers
        • Prioritizing Test Efforts
        • Contributing to Release Informed Decisions
        • Seamless Collaboration with Developers
        • Evaluating Testing Strategy
    • Technical Overview
      • Solution Mechanism
      • Technical Architecture
      • Deployment Guide
  • Features
    • Coverage Dashboard
    • Coverage Report
    • Test Gaps Report
      • Code Changes Calculation
        • Hidden Changes Detection
    • Test Optimization - Savings Breakdown
      • TIA Configuration
    • Settings
      • Token Access & Management
      • Quality Gates
Powered by GitBook
On this page
  • Token Types
  • Browser Extension Tokens
  • Token Access
  • Token Management
  • API Tokens
  • Token Access
  • Token Management
  • Agent Tokens
  • Token Access
  • Token Management

Was this helpful?

  1. Features
  2. Settings

Token Access & Management

PreviousSettingsNextQuality Gates

Last updated 2 months ago

Was this helpful?

SeaLights utilizes tokens for various functionalities, including browser extension, API access, and agent communication.

  • There is no Public API to create, update, or delete Tokens.

  • All Tokens are revocable and rotated by users with relevant permissions at any time, according to the Organization’s policies.

Token Types

SeaLights employs three types of tokens:

  • : Used for browser extension and related functionalities.

  • : Used for SeaLights Public API access.

  • : Used for SeaLights agent communication.


Browser Extension Tokens

Purpose: Used for and related functionalities: displaying SeaLights metrics in your SCM's UI and reporting manual tests.

Token Access

Browser extension tokens are user-based.

  • Browser extension tokens are linked to the user who created them.

  • These tokens inherit the creator's group access at the time of using the token, granting access to applications within the creator's groups.

  • Legacy extension tokens have global access (access to all applications).

Token Management

  • Each user can have only one browser extension tokens.

    • The Create New Token button is disabled if a non-legacy token already exists.

  • Users can view, copy, download, refresh, and delete their own browser extension token.

  • Legacy token are only visible to Admin/DevOps users, and their actions (copy, download, refresh) are disabled

  • If the token creator is deactivated or deleted, the extension token is automatically deactivated or deleted.

Token List & Token Creation
  • Go to Browser Extension Tokes on the side menu, under Integration.

  • Press Create New Token button, provide a name to your token and save.

  • Press Copy Token button and use it according to the specific SeaLights integration requirements.


API Tokens

Purpose: Used for authentication in SeaLights public API.

Token Access

API tokens are group-based.

  • API tokens are linked to specific user groups, granting access to applications within those groups.

  • The user groups are linked to the token automatically or by user selection, at the time of creating the token or updating it.

  • Legacy extension tokens have global access (access to all applications).

  • New tokens can also have global access.

Token Management

  • Only Admin/DevOps users can access the API token page.

  • Tokens with Global Access can be viewed by:

    • All Admin/DevOps users, in case this is a legacy token.

    • Admin/DevOps users with permission for manage Users and Permissions, in case this is a non-legacy token with Global Access.

  • Admin/DevOps users can view only API tokens with access to groups they are authorized to view:

    • Admin/DevOps users must be assigned to all groups the token has access to, in order to view the token.

      • Example 1: Token with access to groups A and B, can be viewed by an Admin/DevOps user that is assigned to groups A, B, C.

      • Example 2: Token with access to groups A and D, cannot be viewed by an Admin/DevOps user that is assigned to groups A, B, C.

    • Admin/DevOps users with permission for manage Users and Permissions can view all tokens, even if they are not assigned to groups.

  • Admin/DevOps users can copy, download, and refresh tokens based on their group authorization.

  • Admin/DevOps users with permission for manage Users and Permissions will not be able to copy / download / refresh, if not assigned to all the groups a token has access to.

  • Admin/DevOps users that are able to view a specific token with Global Access can also copy / download / refresh the token.

  • Admin/DevOps users can disable/enable tokens.

  • Deletion is only possible after disabling.

  • Admin/DevOps users can add groups to existing tokens if additional groups are available. There is no option to remove a group that was already added.

Creating a token does not provide access to this token forever. The creator of a token can view a token as long as his/her assigned groups are aligned with the groups the token has access to.

Token List & Token Creation
  • Go to API Tokes on the side menu, under Integration. Cockpit & Onboarding

  • Press Create New Token button, provide a name to your token and save, and select access level, if required.

  • Press Copy Token button and use it according to the specific SeaLights integration requirements.

  • Alternatively press Download Token button and use the sltoken.txt file downloaded according to your integration requirements.


Agent Tokens

Purpose: Used for authentication in SeaLights Agents.

Token Access

API tokens are group-based.

  • API tokens are linked to specific user groups, granting access to applications within those groups.

  • The user groups are linked to the token automatically or by user selection, at the time of creating the token or updating it.

  • Legacy extension tokens have global access (access to all applications).

  • New tokens can also have global access.

Token Management

  • Only DevOps users can access the API token page.

  • Tokens with Global Access can be viewed by:

    • All DevOps users, in case this is a legacy token.

    • DevOps users with permission for manage Users and Permissions, in case this is a non-legacy token with Global Access.

  • DevOps users can view only API tokens with access to groups they are authorized to view:

    • DevOps users must be assigned to all groups the token has access to, in order to view the token.

      • Example 1: Token with access to groups A and B, can be viewed by a DevOps user that is assigned to groups A, B, C.

      • Example 2: Token with access to groups A and D, cannot be viewed by a DevOps user that is assigned to groups A, B, C.

    • DevOps users with permission for manage Users and Permissions can view all tokens, even if they are not assigned to groups.

  • DevOps users can copy, download, and refresh tokens based on their group authorization.

  • DevOps users with permission for manage Users and Permissions will not be able to copy / download / refresh, if not assigned to all the groups a token has access to.

  • DevOps users that are able to view a specific token with Global Access can also copy / download / refresh the token.

  • DevOps users can disable/enable tokens.

  • Deletion is only possible after disabling.

  • DevOps users can add groups to existing tokens if additional groups are available. There is no option to remove a group that was already added.

Creating a token does not provide access to this token forever. The creator of a token can view a token as long as his/her assigned groups are aligned with the groups the token has access to.

Token List & Token Creation
  • Go to API Tokes on the side menu, under Cockpit & Onboarding.

  • Press Create New Token button, provide a name to your token and save, and select access level, if required.

  • Press Copy Token button and use it according to the specific SeaLights integration requirements.

  • Alternatively press Download Token button and use the sltoken.txt file downloaded according to your integration requirements.

Open the SeaLights Settings page, from the Settings button on the top right.

Open the SeaLights Settings page, from the Settings button on the top right. |

Open the SeaLights Settings page, from the Settings button on the top right.

SeaLights browser extension
Browser Extension Tokens
API Tokens
Agent Tokens