IBM Support

QRadar EDR (formerly ReaQta): Authentication of API client

How To


Summary

This article covers the authentication process of API client applications.

Steps

The QRadar EDR (formerly ReaQta) API uses JSON Web Tokens (JWTs) to authenticate the API client. JWTs are issued by the Hive server.

The API client handles generating and refreshing these tokens automatically, so it is necessary to provide your application's ID and Secret when you instantiate the client.

To authenticate an external API client, you need to send an API request that uses the POST method from the client.

 image-20220401133809-1

Steps to execute:

  1. Method: POST method is used.
  2. Request URL: API call /1/authenticate is used for authentication request. The Request URL looks like:
    https://<Hive Server URL>/rqt-api/1/authenticate
    • Note: While working with ReaQta APIs, make sure to add /rqt-api/ as prefix to the API call.
  3. Request Body: Provide the App ID and Secret Key of the API Application already created in the Hive Server. See QRadar EDR (formerly ReaQta): Creating API applications from Hive Server Dashboard for more details regarding API Application.
    {
      "secret": "<Enter the Secret Key string>",
      "id": "<Enter the App ID string>"
    }
  4. Header: Make sure to provide the required HTTP Header. For example: 
    ContentType: application/json
  5. Responses: You receive following response codes according to the success or failure of your API request.
    Status Code Description  Example Response Value
    200 OK
    {
      "token": "xxxxx.yyyyy.zzzzz",
      "expiresAt": 1617982282
    }
    401 Unauthorized 
    {
      "message": "Authentication failed"
    }

Additional Information

For successful run of all API requests, you have to first authenticate the API client then provide the token generated in response after a successful authentication as the header in following manner:
Authorization: Bearer <token>

Document Location

Worldwide

[{"Type":"MASTER","Line of Business":{"code":"LOB24","label":"Security Software"},"Business Unit":{"code":"BU059","label":"IBM Software w\/o TPS"},"Product":{"code":"SSVOEH","label":"IBM Security ReaQta"},"ARM Category":[{"code":"a8m3p000000hBSaAAM","label":"Configuration"}],"ARM Case Number":"","Platform":[{"code":"PF025","label":"Platform Independent"}],"Version":"All Versions"}]

Product Synonym

ReaQta

Document Information

Modified date:
17 May 2023

UID

ibm16568695