Skip to main content

Generating a Refresh Token (API Key)

If you have user credentials for Checkmarx One, you can obtain a refresh token (API Key) from the Authentication API using your account’s username and password. Alternatively, you can log in to Checkmarx One and generate a refresh key (API Key).

The roles (permissions) assigned to the API Key are inherited from the user account that generates the key. Therefore, make sure that you are logged in to an account with the appropriate. See Managing Roles

Warning

Whenever you update your Checkmarx One license (e.g., adding a new scanner) all existing API Keys become invalid. You will need to generate new API Keys to replace those that are used in your integrations and plugins.

Figure 1. 
Generating_an_API_Key.gif

GIF - How to generate an API Key



To generate a refresh token via Checkmarx One:

  1. Log in to the Checkmarx One web portal and select Identity_and_Access_MGMT.png User Management in the main navigation.

    The IAM portal opens.

  2. Click API Keys in the main navigation.

  3. Click Create Key.

    Image_995.png

    A new key is created with the permissions of the current user assigned to it, and a dialog opens showing the API Key.

  4. If you would like to get the curl request for generating an Access Key (i.e., a bearer token to be submitted with the API calls), click on Show details to expand the display.

    Image_998.png

  5. Copy the API Key and/or the curl and save them in a place where you will be able to retrieve them for future use. Then, click OK to close the dialog.

In this section: