Class Security

Handles Bearer Token Authentication for Checkmarx On-Premise REST API requests.

Example

const security = new Security(
  'https://checkmarx.example.com',
  'my-bearer-token'
);

const headers = security.getHeaders();
// { Authorization: 'Bearer <token>', 'Content-Type': 'application/json', Accept: 'application/json' }

Constructors

constructor

Methods

getApiUrl getAuthorizationHeader getHeaders updateToken

Constructors

constructor

  • new Security(apiUrl: string, token: string): Security

    Creates a new Security instance with Bearer Token Authentication credentials.

    Parameters

    • apiUrl: string

      The base URL of the Checkmarx instance (e.g., https://checkmarx.example.com). Must be a valid URL; throws if it cannot be parsed.

    • token: string

      The bearer token or refresh token to authenticate with

    Returns Security

    Throws

    If apiUrl is not a valid URL

Methods

getApiUrl

  • getApiUrl(): string

    Returns the base URL of the Checkmarx instance, without a trailing slash.

    Returns string

    The API base URL

getAuthorizationHeader

  • getAuthorizationHeader(): string

    Returns the value of the Authorization header for Bearer Authentication.

    Returns string

    The Authorization header value in the format Bearer <access_token>

getHeaders

  • getHeaders(): Record<string, string>

    Returns the full set of HTTP headers required for authenticated API requests.

    Returns Record<string, string>

    An object containing Authorization, Content-Type, and Accept headers

updateToken

  • updateToken(tokenType: string, accessToken: string): void

    Updates the Authorization header with a new access token obtained from the auth endpoint. Called automatically by CheckmarxClient.authenticate after a successful token exchange.

    Parameters

    • tokenType: string

      The token type returned by the auth endpoint (e.g., 'Bearer')

    • accessToken: string

      The access token returned by the auth endpoint

    Returns void

Settings

Member Visibility

On This Page

Constructors
Methods