Checkmarx One

Connection Requirements

1 - Url

The URL address of the Checkmarx One instance.

• US: https://ast.checkmarx.net

• US2: https://us.ast.checkmarx.net

• EU: https://eu.ast.checkmarx.net

• EU2: https://eu-2.ast.checkmarx.net

• DEU: https://deu.ast.checkmarx.net

• Australia & New Zealand: https://anz.ast.checkmarx.net

• India: https://ind.ast.checkmarx.net

• India 2: https://ind-2.ast.checkmarx.net

• Singapore: https://sng.ast.checkmarx.net

• UAE: https://mea.ast.checkmarx.net

• Israel: https://gov-il.ast.checkmarx.net

2 - Json Web Token

Generating an Json Web Token

• Log in to the Checkmarx One web portal and select Settings > Identity and Access Management in the main navigation.

• In the main navigation, click API Keys, then click on the Create Key button.

• You can optionally adjust the configuration by adding a descriptive note to the API key, and setting its expiration period between 30 and 365 days (please note that this field will be locked if an administrator has enforced a default expiration period). Additionally, you can specify notification emails for recipients who should be alerted about the key's expiration; the current user's email is included by default, but you can add more by entering each address and clicking 'Add'.

• Click Create. The API Key is created and a window opens showing the key.

• Copy the key and save it in a place where you will be able to retrieve it for future use.

• Once you close the window, you will no longer be able to access this API Key.

• You can obtain a curl for submitting the request for an access token, by clicking on Show details and copying the content.

Attention

The access token inherits whichever roles (permissions) are assigned to the user who generates the API Key. Therefore, make sure that you are using an account with the appropriate permissions.

The minimum required roles (permissions) for running an end-to-end flow of scanning a project and viewing results are the out-of-the-box composite role ast-scanner as well as the IAM role default-roles

3 - Per Page

Number of records to fetch per request (default: 20).

4 - Port

Port number (optional, default: 443).

5 - Scan Status

A filter that determines which scan statuses are considered when retrieving a project's latest scan. Only the results of scans with this status are collected. (Default: Completed)

6 - Engine

Determines which Checkmarx One scan engine results will be retrieved; the latest scans of the projects are filtered based on these engines. Default: sast (Valid values: sast, sca, kics, apisec). Accepts multiple values.

7 - Is Secure

Choose this if your connection is going to be over HTTPS (optional, default: True).

8 - Timeout

The amount of time (in seconds) to wait for API responses. (default: 30)

9 - Proxy

Proxy URL (optional).

10 - Thread Count

This adapter works in a multi-threaded manner. This field represents the number of parallel threads that is going to be constructed for sending API requests (default: 32, min: 1, max: 32).

11 - Sleep Time

Delay in seconds between thread batches (default: 0). Increase if encountering rate limit errors.

Attention

Please perform a connection test to ensure there is a valid connection to the Checkmarx One host. When the discovery operation is finalized you will be able to see the details on Assets page.