Enterprise TruRisk™ Platform Release 3.23.0.0-2 API

January 06, 2026

The Enterprise TruRisk™ Platform (ETP) Release 3.23.0.0-2 supersedes its previous release 3.23.0.0. All the features and enhancements supported with ETP 3.23.0.0 are also supported with this release. Refer to the Enterprise TruRisk™ Platform Release 3.23 API to learn more about the features available for this release of ETP.

Cloud Agent

Token-based API Authentication

With this release, we are introducing token-based authentication for Cloud Agent APIs. This update allows for secure authentication and authorization of API access directly from the user interface. Our API interactions are now authenticated with enhanced security measures.

You can generate the JWT access token by providing the client ID and client secret key in the following API request headers.

For more information on client ID and client secret key, refer to Token-based API Authentication.

Generate Token for Subscription Level Client

POST /auth/oidc

Use this API endpoint to generate an authentication token using Client ID and Client Secret Key for a subscription-level client.

Permissions Required: Need UI and API Access Permissions.

Input ParametersInput Parameters

You must provide the following input parameters in the API Request header to generate an authentication token.

Input Parameters	Mandatory/Optional	Data Type	Description
clientSecret	Mandatory	String	Provide the client secret key generated while creating the user-level or subscription-level client.
clientId	Mandatory	String	Provide the Client ID for the user-level or subscription-level client for whom you want to generate the JWT Token.
encrypted {}	Optional	String	Provide the encryption details for JWT Token. The encrypted JWT Tokens improve the security. For example, RSA512. Syntax: data-urlencode=encrypted RSA512

Sample: Generate an Authentication Token for OIDCSample: Generate an Authentication Token for OIDC

This API illustrates generating an authentication token to access Qualys APIs using the Client ID and Client Secret Key. Provide the Client ID and Client Secret Key in the API request to fetch the authentication token.

API Request

 
    curl -X POST '<qualys_base_url>/auth/oidc'
    --header 'clientSecret: wJalrXUtnFEMI/K7MDENG+bPxRfiCYEXAMPLEKEY'
    --header 'clientId: 123e4567-e89b-12d3-a456-426614174000'
    --data-raw ''

API Response

 
    eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.
    eyJzdWIiOiJjbGllbnQxMjM0NTYiLCJzYwZXM
    iOlsiYXBpLnJlYWQiLCJhcGkud3JpdGUiXSwi
    aXNzIjoiaHR0cHM6Ly9kdW1teS1hdXRoLmNvb
    SIsImV4cCI6MTcwMDAwMDAwMH0.SdXn3I6yTb-
    JNk9LPjR8W9xAtH7dN3Mqf3HdJ5WnRfE

Generate Token for User Level Client

POST /auth/oauth

Use this API endpoint to generate an authentication token using Client ID and Client Secret Key for a user-level client.

Permissions Required: Need UI and API Access Permissions.

Sample: Generate an Authentication Token for OAuthSample: Generate an Authentication Token for OAuth

This API illustrates generating an Authentication Token to access Qualys APIs using the Client ID and Client Secret Key. Provide the Client ID and Client Secret Key in the API request to fetch the JWT token.

API Request

 
    curl -X POST '<qualys_base_url>/auth/oidc'
    --header 'clientSecret: wJalrXUtnFEMI/K7MDENG+bPxRfiCYEXAMPLEKEY'
    --header 'clientId: 123e4567-e89b-12d3-a456-426614174000'
    --data-raw ''

API Response

 
    eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.
    eyJzdWIiOiJjbGllbnQxMjM0NTYiLCJzYwZXM
    iOlsiYXBpLnJlYWQiLCJhcGkud3JpdGUiXSwi
    aXNzIjoiaHR0cHM6Ly9kdW1teS1hdXRoLmNvb
    SIsImV4cCI6MTcwMDAwMDAwMH0.SdXn3I6yTb-
    JNk9LPjR8W9xAtH7dN3Mqf3HdJ5WnRfE

Access Cloud Agent APIs

Provide the Authentication tokens generated for the user-level and subscription-level in the API Authorization header to access the Cloud Agent APIs.

Sample: Access Cloud Agent API with Authentication TokenSample: Access Cloud Agent API with Authentication Token

The following sample illustrates API Authentication using JWT Access Tokens.

API Request


    curl --location --request POST '<qualys_base_url> /caui/v1/activation-keys/manage’
    --header 'Content-Type: application/json' \
    --header 'Authorization: Bearer <JWT Token>' \

Set the authorization type to Bearer token and enter the JWT token value generated using the Oauth or OIDC API.

API Request Body

 
    --data ''
      {
         "limit": 200,  
         "sortOrder": "ASC",
         "orderBy": "TITLE",
         "query": "activationKey.isDisabled:false"
         }

API Response


  {
         "pageSize": 5,
         "totalCount": 745,
         "noOfPages": 149,
         "content": [
         {
            "id": 12345678,
            "title": "activation_key_title_1",
            "activationKey": "123456-1a2b-1a2b-1a2b-12ab12b2b123",
            "countUsed": 0,
            "countPurchased": 0,
            "datePurchased": "2025-01-09T18:01:02",
            "firstName": "John",
            "lastName": "Doe",
            "userName": "<username01>",
            "keyType": "Unlimited",
            "isDisabled": false,
            "expireDate": null,
            "licenses": [
               "PM",
               "VM",
               "FIM",
               "PA",
               "EDR"
            ]
        },
        {
          "id": 23456789,
          "title": "activation_key_title_2",
          "activationKey": "123456-1a2b-1a2b-1a2b-12ab12b2b122",
          "countUsed": 0,
          "countPurchased": 0,
          "datePurchased": "2025-01-29T12:26:26",
          "firstName": "John",
          "lastName": "Doe",
          "userName": "<username01>",
          "keyType": "Unlimited",
          "isDisabled": false,
          "expireDate": null,
          "licenses": []
        },
        {
          "id": 34567891,
          "title": "activation_key_title3",
          "activationKey": "123456-1a2b-1a2b-1a2b-12ab12b2b124",
          "countUsed": 0,
          "countPurchased": 0,
          "datePurchased": "2025-01-29T09:41:04",
          "firstName": "John",
          "lastName": "Doe",
          "userName": "<username01>",
          "keyType": "Unlimited",
          "isDisabled": false,
          "expireDate": null,
          "licenses": [
            "VM",
            "FIM",
            "EDR"
          ]
        },
        {
          "id": 456789123,
          "title": "activation_key_title4",
          "activationKey": "123456-1a2b-1a2b-1a2b-12ab12b2b124",
          "countUsed": 0,
          "countPurchased": 0,
          "datePurchased": "2025-01-29T09:46:07",
          "firstName": "John",
          "lastName": "Doe",
          "userName": "<username01>",
          "keyType": "Unlimited",
          "isDisabled": false,
          "expireDate": null,
          "licenses": []
        },
        {
          "id": 567891234,
          "title": "activation_key_title5",
          "activationKey": "123456-1a2b-1a2b-1a2b-12ab12b2b124",
          "countUsed": 0,
          "countPurchased": 0,
          "datePurchased": "2024-08-14T18:08:36",
          "firstName": "John",
          "lastName": "Doe",
          "userName": "username01",
          "keyType": "Unlimited",
          "isDisabled": false,
          "expireDate": null,
          "licenses": []
        }
      ]
    }