Version:

Version:


Table of Contents

Copy Link

About the connector

IBM QRadar SIEM helps your business by detecting anomalies, uncovering advanced threats, and removing false positives. It consolidates log events and network flow data from thousands of devices, endpoints, and applications distributed throughout a network.

This document provides information about the IBM QRadar connector, which facilitates automated interactions, with a QRadar server using FortiSOAR™ playbooks. Add the IBM QRadar connector as a step in FortiSOAR™ playbooks and perform automated operations, such as automatically getting information about the offenses and details of the offenses from QRadar and also querying a QRadar device.

You can use FortiSOAR™'s Data Ingestion Wizard to easily ingest data into FortiSOAR™ by pulling offenses from IBM QRadar. For more information, see the Data Ingestion Support section.

Version information

Connector Version: 1.5.1

FortiSOAR™ Version Tested on: 7.2.1-1021

IBM QRadar Version Tested on: 7.4.1

Authored By: Fortinet

Certified: Yes

Release Notes for version 1.5.1

Following enhancements have been made to the IBM QRadar connector in version 1.5.1:

  • Updated jinja .timestamp to .int_timestamp in the data ingestion playbooks.
  • Added the "PATCH" option to the "Request Method" parameter of the "Invoke QRadar REST API" operation.
  • Added multiple configurations support for Data Ingestion to ensure that the respective global variables based on the selected configuration are used. Earlier, even when there were multiple configurations, only one global variable was used. 

Installing the connector

Use the Content Hub to install the connector. For the detailed procedure to install a connector, click here.
You can also use the following yum command as a root user to install connectors from an SSH session:
yum install cyops-connector-qradar

Prerequisites to configuring the connector

  • You must have the IP address of the IBM QRadar server to which you will connect and perform the automated operations and API token to access that server.
  • The FortiSOAR™ server should have outbound connectivity to port 443 on the IBM QRadar server.
  • You must have the appropriate access to the IBM QRadar API to perform connector actions. The required permissions have been defined in the RESTful API documentation.
  • The IBM QRadar connector specifically uses: /api/ariel/* and /api/siem/* APIs, therefore ensure that you have the appropriate access as required by these APIs.

Minimum Permissions Required

  • Not Applicable

Configuring the connector

For the procedure to configure a connector, click here.

Configuration parameters

In FortiSOAR™, on the Content Hub (or Connector Store) page, click the Manage tab, and then click the IBM QRadar connector card. On the connector popup, click the Configurations tab to enter the required configuration details: 

Parameter Description
Address Specify the IP address of the QRadar server from where the connector gets offenses information and to which you connect and perform automated operations.
API Token Specify the API token to access the QRadar server to which you connect and perform automated operations.
API Version Specify the version of the QRadar API to be used for performing automated operations.
Verify SSL Specifies whether the SSL certificate for the server is to be verified or not.
Defaults to True.

Actions supported by the connector

The following automated operations can be included in playbooks, and you can also use the annotations to access operations:

Function Description Annotation and Category
Get Offenses from QRadar Retrieves a list of offenses from the QRadar server based on the filter string that you have specified. get_offenses
Investigation
Get Events Related to an Offense Retrieves details of events associated with a QRadar offense, from the QRadar server, based on the QRadar offense ID that you have specified. get_events
Investigation
Make an Ariel Query to QRadar Executes an Ariel query on the QRadar server. QRadar uses the Ariel Query Language (AQL) to search for offenses or events based on query parameters. run_query
Investigation
Get Offense Closing Reasons Retrieves a list of closing reasons associated with all offenses from the QRadar server. get_offense_closing_reasons
Remediation
Close Offense Closes an offense on the QRadar server based on the offense ID that you have specified. close_offense
Remediation
Get Source IP Addresses Retrieves IP address details associated with source address IDs from the QRadar server, based on the source address IDs that you have specified ip_details
Investigation
Get Destination IP Addresses Retrieves IP address details associated with the destination address IDs from the QRadar server, based on the destination address IDs that you have specified ip_details
Investigation
Invoke QRadar REST API Invokes a function to Get or Post an API endpoint on the QRadar server. api_call
Miscellaneous
Get Offense Types Retrieves a list containing IDs of all the offense types from the QRadar server. get_offense_type
Investigation
Manipulate Reference Set Content Adds or deletes the content that you have specified from a specified reference set on QRadar. handle_reference_set_value
Investigation
 
Get Offense Notes Retrieves a list of notes associated with a specified offense in QRadar based on the offense ID you have specified. get_notes
Remediation
Create Note Creates a note for a specified offense in QRadar based on the offense ID you have specified. add_notes
Remediation

operation: Get Offenses from QRadar

Input parameters

Parameter Description
Filter String Filter string based on which you want to retrieve the list of offenses from QRadar.
For example, assigned_to="admin".

Output

The JSON output contains a list of offenses retrieved from the QRadar server, based on the filter string that you have specified.

The output contains the following populated JSON schema:
{
     "source_count": "",
     "credibility": "",
     "status": "",
     "categories": [
         ""
     ],
     "protected": "",
     "offense_source": "",
     "event_count": "",
     "closing_user": "",
     "closing_reason_id": "",
     "policy_category_count": "",
     "last_updated_time": 1501624285172,
     "severity": "",
     "username_count": "",
     "description": "",
     "assigned_to": "",
     "destination_networks": [
         ""
     ],
     "security_category_count": "",
     "start_time": 1501624284334,
     "id": "",
     "offense_type": "",
     "relevance": "",
     "device_count": "",
     "magnitude": "",
     "domain_id": "",
     "local_destination_address_ids": [
         ""
     ],
     "inactive": "",
     "source_address_ids": [
         ""
     ],
     "category_count": "",
     "source_network": "",
     "local_destination_count": "",
     "flow_count": "",
     "follow_up": "",
     "close_time": "",
     "remote_destination_count": ""
}

operation: Get Events Related to an Offense

Input parameters

Parameter Description
QRadar Offense ID Offense ID based on which you want to retrieve events from QRadar.
Offense Start Time Specify the number of milliseconds since the epoch from the offense was started.
Offense Last Update Time Specify the number of milliseconds since the epoch from the offense was last modified.
Max Events to return (Optional) Maximum number of events that this operation should return.

Output

A JSON output contains details of events associated with a QRadar offense, retrieved from the QRadar server, based on the QRadar offense ID that you have specified.

The output contains the following populated JSON schema:
{
     "events": [
         {
             "starttime": "",
             "category": "",
             "username": "",
             "logsourceid": "",
             "eventcount": "",
             "protocolid": "",
             "identityip": "",
             "sourceip": "",
             "qid": "",
             "destinationip": "",
             "magnitude": "",
             "sourceport": "",
             "destinationport": ""
         }
     ]
}

operation: Make an Ariel Query to QRadar

Input parameters

Parameter Description
Ariel Search String Ariel query that you want to be run on the QRadar server.

Output

The JSON output contains details of offenses or events depending on the query that you run on the QRadar server. QRadar uses the Ariel Query Language (AQL) to search for offenses or events based on query parameters.

The output contains a non-dictionary value.

operation: Get Offense Closing Reasons

Input parameters

None

Output

The JSON output contains a list of closing reasons associated with all offenses retrieved from the QRadar server.

The output contains the following populated JSON schema:
{
     "is_reserved": "",
     "id": "",
     "text": "",
     "is_deleted": ""
}

operation: Close Offense

Input parameters

Parameter Description
Offense ID Specify the ID of the offense that you want to close on the QRadar server.
Offense Closing Reason - ID Specify the ID of the offense closing reason using which you want to close the offense on the QRadar server.
Closure Note (Optional) Note that you want to associate with the offense that you want to close on the QRadar server.

Output

The JSON output contains the updated offense details, including the status (should be closed) of the specified offense retrieved from the QRadar server.

The output contains the following populated JSON schema:
{
     "source_count": "",
     "credibility": "",
     "status": "",
     "categories": [],
     "protected": "",
     "offense_source": "",
     "event_count": "",
     "closing_user": "",
     "closing_reason_id": "",
     "policy_category_count": "",
     "last_updated_time": "",
     "severity": "",
     "username_count": "",
     "description": "",
     "assigned_to": "",
     "destination_networks": [],
     "security_category_count": "",
     "start_time": "",
     "id": "",
     "offense_type": "",
     "relevance": "",
     "device_count": "",
     "magnitude": "",
     "domain_id": "",
     "local_destination_address_ids": [],
     "inactive": "",
     "source_address_ids": [],
     "category_count": "",
     "source_network": "",
     "local_destination_count": "",
     "flow_count": "",
     "follow_up": "",
     "close_time": "",
     "remote_destination_count": ""
}

operation: Get Source IP Addresses

The offense data provided by QRadar contains the IDs of the source addresses. Use this operation to fetch the IP address details for the specified source address IDs.

Input parameters

Parameter Description
Source Address Ids IDs of source addresses based on which you want to retrieve IP address details from the QRadar server. For example, [3,4,5].

Output

The JSON output contains the IP address details associated with the specified source address IDs, retrieved from the QRadar server.

The output contains the following populated JSON schema:
{
     "id": "",
     "magnitude": "",
     "source_ip": "",
     "network": ""
}

operation: Get Destination IP Addresses

The offense data provided by QRadar contains the IDs of the destination addresses. Use this operation to fetch the IP address details for the specified destination address IDs.

Input parameters

Parameter Description
Destination Address Ids IDs of destination addresses based on which you want to retrieve IP address details from the QRadar server. For example, [3,4,5].

Output

The JSON output contains the IP address details associated with the specified destination address IDs, retrieved from the QRadar server.

The output contains the following populated JSON schema:
{
     "local_destination_ip": "",
     "id": "",
     "magnitude": "",
     "network": ""
}

operation: Invoke QRadar REST API

If you require to invoke a QRadar API apart from the functions that we provide, you can use this function to directly invoke the QRadar API. Refer to IBM documentation for more information on the QRadar REST APIs.

Input parameters

Parameter Description
Endpoint Specifies the REST endpoint. For example, siem or offenses.
Request Method Select the request method. You can choose between GET, POST, or PATCH.
  • If you select GET, then you should specify the Request Parameters parameter. In the Request parameters parameter, specify the request parameters for the specified endpoint.
  • If you select POST, then you can specify either the Request Parameters in JSON Format or the Request Payload in JSON Format parameter. In these parameters, specify either the request parameters or request JSON payload for the specified endpoint.
  • If you select PATCH, then you can specify either the Request Parameters in JSON Format or the Request Payload in JSON Format parameter. In these parameters, specify either the request parameters or request JSON payload for the specified endpoint.
Headers in json format (Optional) Additional JSON formatted headers.
The following headers are already added by the connector:
'Accept': 'application/JSON',
'Content-Type': 'application/JSON',
'SEC': <token>,
'Version': <api_version>,

Output

The JSON output contains the JSON response of the API invoked.

The output contains a non-dictionary value.

operation: Get Offense Types

Input parameters

None

Output

The JSON output contains a list containing IDs of all the offense types retrieved from the QRadar server. You can use the offense type IDs as a filter criterion in the Get Offenses operation.

The output contains the following populated JSON schema:
{
     "id": "",
     "property_name": "",
     "database_type": "",
     "name": "",
     "custom": ""
}

operation: Manipulate Reference Set Content

Input parameters

Parameter Description
Request Method Select the request method option of the operation that you want to perform on the specified reference set in QRadar. You can choose from Retrieves Value, Add Value, or Delete Value.
Reference Set Name Specify the name of the reference set to be used for this operation based on the option you have specified in the Request Method.
  • If you choose Add Value as the Request Method, then this operation will add the specified value to the reference set you have specified in this field.
  • If you choose Delete Value as the Request Method, then this operation will delete the specified value from the reference set you have specified in this field.
  • If you choose Retrieves Value as the Request Method, then this operation will retrieve the values of the reference set you have specified in this field.
Value Specify the value that you want to add or remove from the specified reference set. You must specify the value in this field if you have chosen Add Value or Delete Value as the Request Method. 

Output

The output is conditional and based on the request method that you choose.

For example, if you choose Retrieves Value as the Request Method, then the output contains the following populated JSON schema:
{
"data": [
{
         "first_seen": "",
          "last_seen": "",
          "source": "",
          "value": ""
}
],
          "message": "",
          "element_type": "",
          "timeout_type": "",
          "name": "",
          "number_of_elements": "",
          "creation_time": "",
}

Or for example, if you choose Add Value or Delete Value as the Request Method, then the output contains the following populated JSON schema:
{
          "message": "",
          "element_type": "",
          "timeout_type": "",
          "name": "",
          "number_of_elements": "",
          "creation_time": "",
}

operation: Get Offense Notes

Input parameters

Parameter Description
Offense ID Specify the ID of the offense whose associated notes you want to retrieve from the QRadar server.

Output

The output contains the following populated JSON schema:
{
     "username": "",
     "id": "",
     "create_time": "",
     "note_text": ""
}

operation: Create Note

Input parameters

Parameter Description
Offense ID Specify the ID of the offense for which you want to create a note on the QRadar server.
Closure Note Specify the text of the closure note that you want to create for the specified offense on the QRadar server.

Output

The output contains the following populated JSON schema:
{
     "username": "",
     "id": "",
     "create_time": "",
     "note_text": ""
}

Included playbooks

The Sample - IBM QRadar - 1.5.1 playbook collection comes bundled with the IBM QRadar connector. This playbook contains steps using which you can perform all supported actions. You can see the bundled playbooks in the Automation > Playbooks section in FortiSOAR™ after importing the IBM QRadar connector.

  • API - Push Offense From QRadar:
    Requires installation and configuration of the CyberSponse Application on the QRadar server. See the Installing the CyberSponse Application on the QRadar Server section.
  • > Close Offense
  • Close QRadar Offenses
  • Create Note
  • Get Destination IP Addresses
  • Get Events Related to an Offense
  • Get Offense Notes
  • Get Offenses
  • Get Offense Type
    Requires installation and configuration of the CyberSponse Application on the QRadar server. See the Installing the CyberSponse Application on the QRadar Server section.
  • Get Source IP Addresses
  • > IBM QRadar > Create Alert
  • > IBM QRadar > Fetch
  • IBM QRadar > Ingest
  • >> IBM QRadar > Init Macros
  • IBM QRadar > Post Create Alert > Fetch Events
  • Invoke QRadar REST API
  • Manipulate Reference Set Content
  • >> QRadar > On Offense Modified
  • Run Ariel Query

Note: If you are planning to use any of the sample playbooks in your environment, ensure that you clone those playbooks and move them to a different collection since the sample playbook collection gets deleted during the connector upgrade and delete.

Data Ingestion Support

Use the Data Ingestion Wizard to easily ingest data into FortiSOAR™ by pulling offenses from IBM QRadar. Currently, "offenses" in IBM QRadar are mapped to "alerts" in FortiSOAR™. For more information on the Data Ingestion Wizard, see the "Connectors Guide" in the FortiSOAR™ product documentation.

Configure Data Ingestion

You can configure data ingestion using the “Data Ingestion Wizard” to seamlessly map the incoming IBM QRadar "offenses" to FortiSOAR™ "alerts".

The Data Ingestion Wizard enables you to configure the scheduled pulling of data from IBM QRadar into FortiSOAR™. It also lets you pull some sample data from IBM QRadar using which you can define the mapping of data between IBM QRadar and FortiSOAR™. The mapping of common fields is generally already done by the Data Ingestion Wizard; users are mostly required to only map any custom fields that are added to the IBM QRadar incident. 

  1. To begin configuring data ingestion, click Configure Data Ingestion on the IBM QRadar connector’s "Configurations" page. 
    Click Let’s Start by fetching some data, to open the “Fetch Sample Data” screen:

    Sample data is required to create a field mapping between QRadar data and FortiSOAR™. The sample data is pulled from connector actions or ingestion playbooks.
  2. On the Fetch Data screen, provide the configurations required to fetch IBM QRadar offenses.
    In the Search Query field, type the query based on which you want to retrieve the list of offenses from IBM QRadar.
    For example, if you want to fetch all "Open" offenses from IBM QRadar, then type status="OPEN" in the Search Query field.
    In the Pull Offense in the last x minutes field, type the time in minutes from when you want to pull offenses from IBM QRadar.
    In the Timezone of the QRadar server field, type the timezone in which your IBM QRadar server is located. For example, UTC.
    In the Event Record Limit field, type the maximum number of events that you want to pull for an offense from the IBM QRadar server.

    Once you have completed specifying the configurations, click Fetch Data.
  3. On the Field Mapping screen, map the fields of an IBM QRadar offense to the fields of an alert present in FortiSOAR™. The Field Mapping screen displays the Sample Data on the right side and the Field Mapping (FortiSOAR™ fields) on the left side. The sample data is in the form of a Key-Value pair.
    From the Module drop-down list that appears next to Field Mapping, select the FortiSOAR™ module for which you want to map the fields. The default module, which is Alerts is already selected.
    Note: If you select any module other than the default module, you will require to remap all the fields.
    Also, some fields such as Name and some picklists can come pre-mapped with their jinja value. You do not require to re-map these fields unless you want to override their default values.  
    To map a field, click the key in the sample data to add the “jinja” value of the field. For example, to map the categories parameter of a QRadar offense to the Type parameter of a FortiSOAR™ alert, click the Type field and then click the categories field to populate its keys:

    For more information on field mapping, see the Data Ingestion chapter in the "Connectors Guide" in the FortiSOAR™ product documentation. Once you have completed the mapping of fields, click Save Mapping & Continue.
  4. Use the Scheduling screen to configure schedule-based ingestion, i.e., specify the polling frequency to IBM QRadar, so that the content gets pulled from the IBM QRadar into FortiSOAR™. 
    On the Scheduling screen, from the Do you want to schedule the ingestion? drop-down list, select Yes.
    In the “Configure Schedule Settings” section, specify the Cron expression for the schedule. For example, if you want to pull data from IBM QRadar every morning at 5 am, click Daily, and in the hour box enter 5 , and in the minute box enter 0:

    Once you have completed scheduling, click Save Settings & Continue.
  5. The Summary screen displays a summary of the mapping done, and it also contains links to the Ingestion playbooks.
    Click Done to complete the data ingestion and exit the Data Ingestion Wizard.

Notes on data ingestion

  • The default ingestion flow fetches offenses from IBM QRadar based on the user-specified query and creates FortiSOAR™ alerts. After the alerts are created, another query to IBM QRadar is made to fetch offense-related events, which are then updated into the source data of the alert.
  • If you change the default module for data ingestion, which is set as Alerts to any other module, for example, Incidents, you need to make the following updates:
    • In the IBM QRadar > Post Create Alert > Fetch Events playbook, in the Start step (Post-Create trigger) step, in the Resource field, update the resource from Alerts to the module based on which you want to fetch the data.
      Also, update the Resource field in the Update Alert step (Update Record step) from Alerts to the module based on which you want to fetch the data.  
    • Similarly, In the > QRadar > Create Alert playbook, in the Add a note of offense update step, in the "Correlations" section, you will see an Alerts field that is being set. If you are using a module other than "Alert", then you will see a field with that name and you will require to set that field. For example, if you are using the "Incidents" module, then you will see the Incidents field and you will need to set that to ["{{vars.steps.Create_Record['@id']}}"]
    • If you select any module other than the default module, you will require to remap all the fields. 
  • If you want the IBM QRadar connector to ingest custom fields, then in the IBM QRadar > Post Create Alert > Fetch Events playbook, in the Set Variable step, add custom fields to the event_query_params variable. By default, this is set as starttime,sourceip,destinationip,username,QIDNAME(qid) as 'Event_Name',CATEGORYNAME(category) AS 'Category_Name',LOGSOURCENAME(logsourceid) as 'Log_Source'
    If you have already run the data ingestion wizard, you can change the IBM QRadar > Post Create Alert > Fetch Events playbook that is located at:  Settings > System Fixtures > Data Ingestion Playbooks.

Installing the CyberSponse Application on the QRadar Server

If you want to forward offenses to FortiSOAR™ from the QRadar UI directly, then you require to install and configure the CyberSponse Application on the QRadar server. The extension zip file (CyberSponse_1.1.0.zip) is attached to this document. Upload and install the extension on the QRadar console following the steps described in the following IBM document: Uploading and installing extensions to IBM QRadar deployments.

After the installation, the CyberSponse Integration icon appears in the Plug-ins section of the Admin tab.

CyberSponse Application - CyberSponse Integration icon

Click the CyberSponse Integration icon to open the Server Configuration dialog. Enter the details of the CyberSponse server to which you want to forward the offenses and then click Save.

CyberSponse Application - Server Configuration dialog

Ensure that the QRadar server has connectivity to the FortiSOAR™ server and can send requests to the FortiSOAR™ instance on port 443. Now, you can forward offenses to FortiSOAR™ by using the Create CyOPs alert button in the Offense Summary Toolbar as shown in the following image:

Offense Summary Toolbar - Create CyOPs alert button

Clicking the Create CyOPs alert button sends a POST trigger to the https://<CyOPs>/api/triggers/1/qradar with the payload {“Offense_ID”: <id>} URL.
The API - Push Offense From QRadar included playbook listens to this API trigger and fetches all the data related to the offense specified in the offense id and creates a FortiSOAR™ alert. You can verify the integration with the help of this playbook or make a copy of the playbook and update it as per your requirement. If you make a copy, deactivate the included playbook, to avoid two playbooks acting on the same API trigger.

 

CyberSponse_1.1.0

About the connector

IBM QRadar SIEM helps your business by detecting anomalies, uncovering advanced threats, and removing false positives. It consolidates log events and network flow data from thousands of devices, endpoints, and applications distributed throughout a network.

This document provides information about the IBM QRadar connector, which facilitates automated interactions, with a QRadar server using FortiSOAR™ playbooks. Add the IBM QRadar connector as a step in FortiSOAR™ playbooks and perform automated operations, such as automatically getting information about the offenses and details of the offenses from QRadar and also querying a QRadar device.

You can use FortiSOAR™'s Data Ingestion Wizard to easily ingest data into FortiSOAR™ by pulling offenses from IBM QRadar. For more information, see the Data Ingestion Support section.

Version information

Connector Version: 1.5.1

FortiSOAR™ Version Tested on: 7.2.1-1021

IBM QRadar Version Tested on: 7.4.1

Authored By: Fortinet

Certified: Yes

Release Notes for version 1.5.1

Following enhancements have been made to the IBM QRadar connector in version 1.5.1:

Installing the connector

Use the Content Hub to install the connector. For the detailed procedure to install a connector, click here.
You can also use the following yum command as a root user to install connectors from an SSH session:
yum install cyops-connector-qradar

Prerequisites to configuring the connector

Minimum Permissions Required

Configuring the connector

For the procedure to configure a connector, click here.

Configuration parameters

In FortiSOAR™, on the Content Hub (or Connector Store) page, click the Manage tab, and then click the IBM QRadar connector card. On the connector popup, click the Configurations tab to enter the required configuration details: 

Parameter Description
Address Specify the IP address of the QRadar server from where the connector gets offenses information and to which you connect and perform automated operations.
API Token Specify the API token to access the QRadar server to which you connect and perform automated operations.
API Version Specify the version of the QRadar API to be used for performing automated operations.
Verify SSL Specifies whether the SSL certificate for the server is to be verified or not.
Defaults to True.

Actions supported by the connector

The following automated operations can be included in playbooks, and you can also use the annotations to access operations:

Function Description Annotation and Category
Get Offenses from QRadar Retrieves a list of offenses from the QRadar server based on the filter string that you have specified. get_offenses
Investigation
Get Events Related to an Offense Retrieves details of events associated with a QRadar offense, from the QRadar server, based on the QRadar offense ID that you have specified. get_events
Investigation
Make an Ariel Query to QRadar Executes an Ariel query on the QRadar server. QRadar uses the Ariel Query Language (AQL) to search for offenses or events based on query parameters. run_query
Investigation
Get Offense Closing Reasons Retrieves a list of closing reasons associated with all offenses from the QRadar server. get_offense_closing_reasons
Remediation
Close Offense Closes an offense on the QRadar server based on the offense ID that you have specified. close_offense
Remediation
Get Source IP Addresses Retrieves IP address details associated with source address IDs from the QRadar server, based on the source address IDs that you have specified ip_details
Investigation
Get Destination IP Addresses Retrieves IP address details associated with the destination address IDs from the QRadar server, based on the destination address IDs that you have specified ip_details
Investigation
Invoke QRadar REST API Invokes a function to Get or Post an API endpoint on the QRadar server. api_call
Miscellaneous
Get Offense Types Retrieves a list containing IDs of all the offense types from the QRadar server. get_offense_type
Investigation
Manipulate Reference Set Content Adds or deletes the content that you have specified from a specified reference set on QRadar. handle_reference_set_value
Investigation
 
Get Offense Notes Retrieves a list of notes associated with a specified offense in QRadar based on the offense ID you have specified. get_notes
Remediation
Create Note Creates a note for a specified offense in QRadar based on the offense ID you have specified. add_notes
Remediation

operation: Get Offenses from QRadar

Input parameters

Parameter Description
Filter String Filter string based on which you want to retrieve the list of offenses from QRadar.
For example, assigned_to="admin".

Output

The JSON output contains a list of offenses retrieved from the QRadar server, based on the filter string that you have specified.

The output contains the following populated JSON schema:
{
     "source_count": "",
     "credibility": "",
     "status": "",
     "categories": [
         ""
     ],
     "protected": "",
     "offense_source": "",
     "event_count": "",
     "closing_user": "",
     "closing_reason_id": "",
     "policy_category_count": "",
     "last_updated_time": 1501624285172,
     "severity": "",
     "username_count": "",
     "description": "",
     "assigned_to": "",
     "destination_networks": [
         ""
     ],
     "security_category_count": "",
     "start_time": 1501624284334,
     "id": "",
     "offense_type": "",
     "relevance": "",
     "device_count": "",
     "magnitude": "",
     "domain_id": "",
     "local_destination_address_ids": [
         ""
     ],
     "inactive": "",
     "source_address_ids": [
         ""
     ],
     "category_count": "",
     "source_network": "",
     "local_destination_count": "",
     "flow_count": "",
     "follow_up": "",
     "close_time": "",
     "remote_destination_count": ""
}

operation: Get Events Related to an Offense

Input parameters

Parameter Description
QRadar Offense ID Offense ID based on which you want to retrieve events from QRadar.
Offense Start Time Specify the number of milliseconds since the epoch from the offense was started.
Offense Last Update Time Specify the number of milliseconds since the epoch from the offense was last modified.
Max Events to return (Optional) Maximum number of events that this operation should return.

Output

A JSON output contains details of events associated with a QRadar offense, retrieved from the QRadar server, based on the QRadar offense ID that you have specified.

The output contains the following populated JSON schema:
{
     "events": [
         {
             "starttime": "",
             "category": "",
             "username": "",
             "logsourceid": "",
             "eventcount": "",
             "protocolid": "",
             "identityip": "",
             "sourceip": "",
             "qid": "",
             "destinationip": "",
             "magnitude": "",
             "sourceport": "",
             "destinationport": ""
         }
     ]
}

operation: Make an Ariel Query to QRadar

Input parameters

Parameter Description
Ariel Search String Ariel query that you want to be run on the QRadar server.

Output

The JSON output contains details of offenses or events depending on the query that you run on the QRadar server. QRadar uses the Ariel Query Language (AQL) to search for offenses or events based on query parameters.

The output contains a non-dictionary value.

operation: Get Offense Closing Reasons

Input parameters

None

Output

The JSON output contains a list of closing reasons associated with all offenses retrieved from the QRadar server.

The output contains the following populated JSON schema:
{
     "is_reserved": "",
     "id": "",
     "text": "",
     "is_deleted": ""
}

operation: Close Offense

Input parameters

Parameter Description
Offense ID Specify the ID of the offense that you want to close on the QRadar server.
Offense Closing Reason - ID Specify the ID of the offense closing reason using which you want to close the offense on the QRadar server.
Closure Note (Optional) Note that you want to associate with the offense that you want to close on the QRadar server.

Output

The JSON output contains the updated offense details, including the status (should be closed) of the specified offense retrieved from the QRadar server.

The output contains the following populated JSON schema:
{
     "source_count": "",
     "credibility": "",
     "status": "",
     "categories": [],
     "protected": "",
     "offense_source": "",
     "event_count": "",
     "closing_user": "",
     "closing_reason_id": "",
     "policy_category_count": "",
     "last_updated_time": "",
     "severity": "",
     "username_count": "",
     "description": "",
     "assigned_to": "",
     "destination_networks": [],
     "security_category_count": "",
     "start_time": "",
     "id": "",
     "offense_type": "",
     "relevance": "",
     "device_count": "",
     "magnitude": "",
     "domain_id": "",
     "local_destination_address_ids": [],
     "inactive": "",
     "source_address_ids": [],
     "category_count": "",
     "source_network": "",
     "local_destination_count": "",
     "flow_count": "",
     "follow_up": "",
     "close_time": "",
     "remote_destination_count": ""
}

operation: Get Source IP Addresses

The offense data provided by QRadar contains the IDs of the source addresses. Use this operation to fetch the IP address details for the specified source address IDs.

Input parameters

Parameter Description
Source Address Ids IDs of source addresses based on which you want to retrieve IP address details from the QRadar server. For example, [3,4,5].

Output

The JSON output contains the IP address details associated with the specified source address IDs, retrieved from the QRadar server.

The output contains the following populated JSON schema:
{
     "id": "",
     "magnitude": "",
     "source_ip": "",
     "network": ""
}

operation: Get Destination IP Addresses

The offense data provided by QRadar contains the IDs of the destination addresses. Use this operation to fetch the IP address details for the specified destination address IDs.

Input parameters

Parameter Description
Destination Address Ids IDs of destination addresses based on which you want to retrieve IP address details from the QRadar server. For example, [3,4,5].

Output

The JSON output contains the IP address details associated with the specified destination address IDs, retrieved from the QRadar server.

The output contains the following populated JSON schema:
{
     "local_destination_ip": "",
     "id": "",
     "magnitude": "",
     "network": ""
}

operation: Invoke QRadar REST API

If you require to invoke a QRadar API apart from the functions that we provide, you can use this function to directly invoke the QRadar API. Refer to IBM documentation for more information on the QRadar REST APIs.

Input parameters

Parameter Description
Endpoint Specifies the REST endpoint. For example, siem or offenses.
Request Method Select the request method. You can choose between GET, POST, or PATCH.
  • If you select GET, then you should specify the Request Parameters parameter. In the Request parameters parameter, specify the request parameters for the specified endpoint.
  • If you select POST, then you can specify either the Request Parameters in JSON Format or the Request Payload in JSON Format parameter. In these parameters, specify either the request parameters or request JSON payload for the specified endpoint.
  • If you select PATCH, then you can specify either the Request Parameters in JSON Format or the Request Payload in JSON Format parameter. In these parameters, specify either the request parameters or request JSON payload for the specified endpoint.
Headers in json format (Optional) Additional JSON formatted headers.
The following headers are already added by the connector:
'Accept': 'application/JSON',
'Content-Type': 'application/JSON',
'SEC': <token>,
'Version': <api_version>,

Output

The JSON output contains the JSON response of the API invoked.

The output contains a non-dictionary value.

operation: Get Offense Types

Input parameters

None

Output

The JSON output contains a list containing IDs of all the offense types retrieved from the QRadar server. You can use the offense type IDs as a filter criterion in the Get Offenses operation.

The output contains the following populated JSON schema:
{
     "id": "",
     "property_name": "",
     "database_type": "",
     "name": "",
     "custom": ""
}

operation: Manipulate Reference Set Content

Input parameters

Parameter Description
Request Method Select the request method option of the operation that you want to perform on the specified reference set in QRadar. You can choose from Retrieves Value, Add Value, or Delete Value.
Reference Set Name Specify the name of the reference set to be used for this operation based on the option you have specified in the Request Method.
  • If you choose Add Value as the Request Method, then this operation will add the specified value to the reference set you have specified in this field.
  • If you choose Delete Value as the Request Method, then this operation will delete the specified value from the reference set you have specified in this field.
  • If you choose Retrieves Value as the Request Method, then this operation will retrieve the values of the reference set you have specified in this field.
Value Specify the value that you want to add or remove from the specified reference set. You must specify the value in this field if you have chosen Add Value or Delete Value as the Request Method. 

Output

The output is conditional and based on the request method that you choose.

For example, if you choose Retrieves Value as the Request Method, then the output contains the following populated JSON schema:
{
"data": [
{
         "first_seen": "",
          "last_seen": "",
          "source": "",
          "value": ""
}
],
          "message": "",
          "element_type": "",
          "timeout_type": "",
          "name": "",
          "number_of_elements": "",
          "creation_time": "",
}

Or for example, if you choose Add Value or Delete Value as the Request Method, then the output contains the following populated JSON schema:
{
          "message": "",
          "element_type": "",
          "timeout_type": "",
          "name": "",
          "number_of_elements": "",
          "creation_time": "",
}

operation: Get Offense Notes

Input parameters

Parameter Description
Offense ID Specify the ID of the offense whose associated notes you want to retrieve from the QRadar server.

Output

The output contains the following populated JSON schema:
{
     "username": "",
     "id": "",
     "create_time": "",
     "note_text": ""
}

operation: Create Note

Input parameters

Parameter Description
Offense ID Specify the ID of the offense for which you want to create a note on the QRadar server.
Closure Note Specify the text of the closure note that you want to create for the specified offense on the QRadar server.

Output

The output contains the following populated JSON schema:
{
     "username": "",
     "id": "",
     "create_time": "",
     "note_text": ""
}

Included playbooks

The Sample - IBM QRadar - 1.5.1 playbook collection comes bundled with the IBM QRadar connector. This playbook contains steps using which you can perform all supported actions. You can see the bundled playbooks in the Automation > Playbooks section in FortiSOAR™ after importing the IBM QRadar connector.

Note: If you are planning to use any of the sample playbooks in your environment, ensure that you clone those playbooks and move them to a different collection since the sample playbook collection gets deleted during the connector upgrade and delete.

Data Ingestion Support

Use the Data Ingestion Wizard to easily ingest data into FortiSOAR™ by pulling offenses from IBM QRadar. Currently, "offenses" in IBM QRadar are mapped to "alerts" in FortiSOAR™. For more information on the Data Ingestion Wizard, see the "Connectors Guide" in the FortiSOAR™ product documentation.

Configure Data Ingestion

You can configure data ingestion using the “Data Ingestion Wizard” to seamlessly map the incoming IBM QRadar "offenses" to FortiSOAR™ "alerts".

The Data Ingestion Wizard enables you to configure the scheduled pulling of data from IBM QRadar into FortiSOAR™. It also lets you pull some sample data from IBM QRadar using which you can define the mapping of data between IBM QRadar and FortiSOAR™. The mapping of common fields is generally already done by the Data Ingestion Wizard; users are mostly required to only map any custom fields that are added to the IBM QRadar incident. 

  1. To begin configuring data ingestion, click Configure Data Ingestion on the IBM QRadar connector’s "Configurations" page. 
    Click Let’s Start by fetching some data, to open the “Fetch Sample Data” screen:

    Sample data is required to create a field mapping between QRadar data and FortiSOAR™. The sample data is pulled from connector actions or ingestion playbooks.
  2. On the Fetch Data screen, provide the configurations required to fetch IBM QRadar offenses.
    In the Search Query field, type the query based on which you want to retrieve the list of offenses from IBM QRadar.
    For example, if you want to fetch all "Open" offenses from IBM QRadar, then type status="OPEN" in the Search Query field.
    In the Pull Offense in the last x minutes field, type the time in minutes from when you want to pull offenses from IBM QRadar.
    In the Timezone of the QRadar server field, type the timezone in which your IBM QRadar server is located. For example, UTC.
    In the Event Record Limit field, type the maximum number of events that you want to pull for an offense from the IBM QRadar server.

    Once you have completed specifying the configurations, click Fetch Data.
  3. On the Field Mapping screen, map the fields of an IBM QRadar offense to the fields of an alert present in FortiSOAR™. The Field Mapping screen displays the Sample Data on the right side and the Field Mapping (FortiSOAR™ fields) on the left side. The sample data is in the form of a Key-Value pair.
    From the Module drop-down list that appears next to Field Mapping, select the FortiSOAR™ module for which you want to map the fields. The default module, which is Alerts is already selected.
    Note: If you select any module other than the default module, you will require to remap all the fields.
    Also, some fields such as Name and some picklists can come pre-mapped with their jinja value. You do not require to re-map these fields unless you want to override their default values.  
    To map a field, click the key in the sample data to add the “jinja” value of the field. For example, to map the categories parameter of a QRadar offense to the Type parameter of a FortiSOAR™ alert, click the Type field and then click the categories field to populate its keys:

    For more information on field mapping, see the Data Ingestion chapter in the "Connectors Guide" in the FortiSOAR™ product documentation. Once you have completed the mapping of fields, click Save Mapping & Continue.
  4. Use the Scheduling screen to configure schedule-based ingestion, i.e., specify the polling frequency to IBM QRadar, so that the content gets pulled from the IBM QRadar into FortiSOAR™. 
    On the Scheduling screen, from the Do you want to schedule the ingestion? drop-down list, select Yes.
    In the “Configure Schedule Settings” section, specify the Cron expression for the schedule. For example, if you want to pull data from IBM QRadar every morning at 5 am, click Daily, and in the hour box enter 5 , and in the minute box enter 0:

    Once you have completed scheduling, click Save Settings & Continue.
  5. The Summary screen displays a summary of the mapping done, and it also contains links to the Ingestion playbooks.
    Click Done to complete the data ingestion and exit the Data Ingestion Wizard.

Notes on data ingestion

Installing the CyberSponse Application on the QRadar Server

If you want to forward offenses to FortiSOAR™ from the QRadar UI directly, then you require to install and configure the CyberSponse Application on the QRadar server. The extension zip file (CyberSponse_1.1.0.zip) is attached to this document. Upload and install the extension on the QRadar console following the steps described in the following IBM document: Uploading and installing extensions to IBM QRadar deployments.

After the installation, the CyberSponse Integration icon appears in the Plug-ins section of the Admin tab.

CyberSponse Application - CyberSponse Integration icon

Click the CyberSponse Integration icon to open the Server Configuration dialog. Enter the details of the CyberSponse server to which you want to forward the offenses and then click Save.

CyberSponse Application - Server Configuration dialog

Ensure that the QRadar server has connectivity to the FortiSOAR™ server and can send requests to the FortiSOAR™ instance on port 443. Now, you can forward offenses to FortiSOAR™ by using the Create CyOPs alert button in the Offense Summary Toolbar as shown in the following image:

Offense Summary Toolbar - Create CyOPs alert button

Clicking the Create CyOPs alert button sends a POST trigger to the https://<CyOPs>/api/triggers/1/qradar with the payload {“Offense_ID”: <id>} URL.
The API - Push Offense From QRadar included playbook listens to this API trigger and fetches all the data related to the offense specified in the offense id and creates a FortiSOAR™ alert. You can verify the integration with the help of this playbook or make a copy of the playbook and update it as per your requirement. If you make a copy, deactivate the included playbook, to avoid two playbooks acting on the same API trigger.

 

CyberSponse_1.1.0