×
IBM QRadar (SIEM)
IBM QRadar

Overview

The IBM QRadar plugin adds the ability to manage offenses, create and list offense notes, create and list offense close reasons, and list offense types.

Functionality

The Security Flow IBM QRadar plugin provides the ability to

  • periodically search of offenses
  • find (search for) existing offenses
  • load an existing offense
  • update an existing offense
  • create a note on an existing offense
  • load notes for an existing offense
  • create an offense closing reason
  • load the list of existing offense closing reasons
  • load the list of offense types

Instance Configuration Parameters

Property
Description

Instance Name

Name for the IBM QRadar plugin instance.


Unique ID

A system-wide unique identifier for this plugin instance used to locate the service.


Server

IBM QRadar server IP address or hostname. This is NOT a URL.


Port

IBM QRadar server port for inbound connections. This should typically remain at 443.


Verify Certificate

When enabled, this settings determines if the server’s certificate must be verified before allowing the connection to the QRadar server.


Authentication Token

IBM QRadar Authentication Token. See Creating an authorized service token for details on creating an authentication token.

Flow Nodes

The IBM QRadar Offenses node is used to manage closing reasons, view offense types, find offenses, manage an offense's notes, or update an offense via the SIEM Endpoints API.
Property
Description

Name

The display name of the node within the flows.


Unique ID

A system-wide unique identifier for this plugin instance used to locate the service.


Action

Configuration option determining the type of operation to perform:

  • Find Offenses: Finds offenses matching the supplied configuration.
  • Load Offense: Loads an existing offense.
  • Update Offense: Updates an existing offense.
  • Create Offense Note: Creates a note on an existing offense.
  • Load Offense Notes : Load notes for an existing offense.
  • Create Offense Closing Reason: Creates an offense closing reason.
  • Load Offense Closing Reasons: Loads the list of existing offense closing reasons.
  • Load Offense Types: Loads the list of offense types.

Successful results for an action are placed in msg.payload.qradar.[uniqueId].response.

See the node’s documentation for up-to-date links to the QRadar API endpoint documentation.


Offense ID

The ID number of the offense being loaded or updated. When the Offense ID is set to Standard Offense ID Location, the offense ID is obtained from the standard response location in offense.id.


Filter

The Filter configuration option must conform to the rules specified in the QRadar filter syntax.

The Filter configuration option supports using mustache variable substitution from the incoming message. Visit the Template Engine and Formatters page to learn more.


Protect Offense

To mark an offense as being protected, set this field to a JavaScript truthy value.


Follow Up

To mark an offense as needing follow up, set this field to a JavaScript truthy value.


Status

The Status must evaluate to one of OPEN, HIDDEN, or CLOSED. Any other status value will result in a runtime error.


Closing Reason ID

The Closing Reason ID is evaluated when the status is being set to CLOSED, otherwise it is ignored. When the Closing Reason ID is set to Standard Offense Closing Reason ID Location, the closing reason ID is obtained from the standard response location in either closingReason.id or closingReasons[0].id with preference given to closingReason.id.


Assignee

The username of the assignee for the offense being updated.


Note

The text for the note to add to an offense. The Note configuration option supports using mustache variable substitution from the incoming message. Visit the Template Engine and Formatters page to learn more.


Reason

The closing reason description. The description must be between 5 and 60 characters. The Reason configuration option supports using mustache variable substitution from the incoming message. Visit the Template Engine and Formatters page to learn more.


Selected Fields

The Selected Fields configuration option must evaluate to a comma separated list of field names or an array of field names. The field names depend on the returned object type or array element type.


Closing Reasons: Include Reserved

To load reserved closing reasons, set this field to a JavaScript truthy value.


Closing Reasons: Include Deleted

To load deleted closing reasons, set this field to a JavaScript truthy value.


Details: Load Notes

To load all the notes associated with each matching offense, set this field to a JavaScript truthy value.


Size Limit

The Size Limit configuration option determines the maximum number of results to return. If set to Not Specified, no limit is placed in the request to QRadar.


Sort By

The field to sort matching results by.


Sort Order

The sort order of the matching results.

IBM QRadar Offense search node to find matching offenses to use as triggering events within a flow. Uses the IBM QRadar Offense API to search for matching offenses.
Property
Description

Name

The display name of the node within the flows.


Unique ID

System-wide unique ID of the plugin instance.


Repeat

Use Repeat to define how often a query for offenses is triggered. The left inject button on this node is used to immediately trigger the retrieval of offenses. If the repeat interval is set to zero, querying will not occur unless manually triggered using the left inject button.


Filter

Limit matches to offenses matching the filter criteria. If no filter is specified, this filter is ignored. The Filter configuration option must conform to the rules specified in the QRadar filter syntax.


Created

Time relative to now when the offense was created. If the value is set to zero, it is ignored during the search. This adds a filter criteria on the start_time.


Updated

Time relative to now when the offense was updated. If the value is set to zero, it is ignored during the search. This adds a filter criteria on the last_updated_time.


Fields

Limit the returned fields (columns) of the matching offenses. If no fields are specified, this configuration option is ignored. Specify fields as a comma separated list of fields found in the Offense object.


Size Limit

The maximum number of offenses to find during when this node is triggered. Each offense is sent through the flow as an individual message.


Sort By

Determine the sort field of the matching offenses. If no field name is specified, this configuration option is ignored. Specify a field from the sortable list of fields found in the Offense object.


Sort Order

The sort order of the matching offenses.


Aggregetion

This node supports five modes for aggregating incidents.

  • None: Never aggregate any incidents (default).
  • Field Match: For a given source field of a message (or jsonata query of the message), aggregate together all messages whose field value exactly matches a previously checked message.
  • Exact Match: For a given source field of the message (or jsonata query of the message), aggregate together all messages whose field exactly matches a given value. One can specify multiple values. Each value specifies a separate grouping of incidents. Useful to aggregate messages with known content.
  • Keyword Match: For a given source field of the message (or jsonata query of the message), aggregate together all messages with a given keyword appearing as a word within the field. One can specify multiple keywords. Each keyword specifies a separate grouping of incidents. An incident is grouped with the first keyword it matches. Useful to aggregate messages with somewhat known content.
  • Fuzzy Match: For a given source field of the message (or jsonata query of the message), aggregate together all messages for which this field is sufficiently similar to the message which started the incident. With this method, one can specify a similarity threshold. Messages matched with the fuzzy matcher get a similarity attribute added to the message which can be inspected to assist when establishing a threshold.
Nevelex Labs, Main Office

Metro Office Park
2950 Metro Drive, Suite 104
Bloomington, MN 55425
Phone: +1 952-500-8921

©Nevelex Labs, LLC. 2018-2024, All Rights Reserved.

EULA