Sumo Logic Cloud SIEM Enterprise (CSE) collects, manages, and analyzes log data. It provides real-time operational and security insights across all critical applications and infrastructure, on-premise or in the cloud.
D3 SOAR's integration for Sumo Logic Cloud is using the latest Sumo Logic CSE API (1.0.0) to provide the ability to retrieve insights to D3 as events. It also provides the ability to modify insights.
D3 SOAR is providing REST operations to function with Sumo Logic Cloud SIEM Enterprise (Sumo Logic CSE).
Sumo Logic Cloud SIEM Enterprise (Sumo Logic CSE) is available for use in:
On the Security page, select the Access Keys tab at the top.
Click + Add Access Key to create a new access key. The access key configuration window will open.
Create a new Access Key.
Input a name for the new access key.
(Optional) Allow CORS domains by adding a domain to the allow list. This will ensure that Sumo Logic only accepts API requests from the specified domain.
Click on the Integration icon on the left sidebar.
Type Sumo Logic Cloud SIEM Enterprise (Sumo Logic CSE) in the search box to find the integration, then click it to select it.
Click New Connection, on the right side of the Connections section. A new connection window will appear.
Configure the following fields to create a connection to Sumo Logic Cloud SIEM Enterprise (Sumo Logic CSE).
Connection Name: The desired name for the connection.
Site: Specifies the site to use the integration connection. Use the drop-down menu to select the site. The Share to Internal Sites option enables all sites defined as internal sites to use the connection. Selecting a specific site will only enable that site to use the connection.
Recipient site for events from connections Shared to Internal Sites: This field appears if you selected Share to Internal Sites for Site to let you select the internal site to deploy the integration connection.
Agent Name (Optional): Specifies the proxy agent required to build the connection. Use the dropdown menu to select the proxy agent from a list of previously configured proxy agents.
Description (Optional): Add your desired description for the connection.
Tenant (Optional): When configuring the connection from a master tenant site, you have Whether to choose the specific tenant sites you want to share the connection with. Once you enable this setting, you can filter and select the desired tenant sites from the dropdowns to share the connection.
Configure User Permissions: Defines which users have access to the connection.
Active: Check the tick box to ensure the connection is available for use.
Run command when Event dismiss: Checking the tick box will run the corresponding On Dismiss Event command(s) under this integration connection to update an Insight status after dismissal as an ingested D3 SOAR event.
System: This section contains the parameters defined specifically for the integration. These parameters must be configured to create the integration connection.
1. Input the domain level Server URL. The default value is https://api.<ReplaceMe>.sumologic.com.
4. Input the API version. The default version is v1.
Connection Health Check: Updates the connection status you have created. A connection health check is done by scheduling the Test Connection command of this integration. This can only be done when the connection is active.
To set up a connection health check, check the Connection Health Check tickbox. You can customize the interval (minutes) for scheduling the health check. An email notification can be set up after a specified number of failed connection attempts.
Enable Password Vault: An optional feature that allows users to take the stored credentials from their own password vault. Refer to the password vault connection guide if needed.
Test the connection.
Click Test Connection to verify the account credentials and network connection. If the Test Connection Passed alert window appears, the test connection is successful. You will see Passed with a green check markappear beside the Test Connection button. If the test connection fails, please check your connection parameters and try again.
Click OK to close the alert window.
Click Add to create and add the configured connection.
Commands
Sumo Logic Cloud SIEM Enterprise (Sumo Logic CSE) includes the following executable commands for users to set up schedules or create playbook workflows. With the Test Command, you can execute these commands independently for playbook troubleshooting.
Integration API Note
For more information about the Sumo Logic API, see the following API reference:
The input format of time-related parameters may vary based on your account settings. As a result, the sample data provided in our commands is different from what you see. To set your preferred time format, follow these steps:
Navigate to Configuration > Application Settings. Select Date/Time Format.
Choose your desired date and time format.
After that, you will be able to view your preferred time format when configuring the DateTime input parameters for commands.
Add Comment To Insight
Adds a comment to the specified Insights.
READER NOTE
Insight IDs is a required parameter to run this command.
Run the Fetch Event command to obtain the Insight IDs. Insight IDs can be found in the raw data at the path $.data.objects[*].id.
The user who created the connection (using an access ID and key) will be the author of the comment, and their email will be included in the response.
Input
Input Parameter
Required/Optional
Description
Example
Insight IDs
Required
The ID of the insights to add a comment. Insight IDs can be obtained using the Fetch Event command.
JSON
[
"*****"
]
Comment
Required
The comment to add to the Insights.
No Action Needed
Output
Return Data
Indicates one of the possible command execution states: Successful, Partially Successful, or Failed.
The Partially Successful state only occurs when a command’s input accepts an array of items (e.g. an array of IP addresses) and one or more items within the array return an error from the API request.
The Failed state can be triggered by any of the following errors:
A connection issue with the integration
The API returned an error message
No response from the API
You can view more details about an error in the Error tab.
Return Data can be passed down directly to a subsequent command or used to create conditional tasks in playbooks.
If the Return Data is Partially Successful or Failed, an Error tab will appear in the Test Result window.
The errortab contains the details responded from D3 SOAR or third-party API calls, including Failure Indicator, Status Code, and Message. This can help you locate the root cause of a command failure.
Parts in Error
Description
Example
Failure Indicator
Indicates the command failure that happened at a specific input and/or API call.
Add Comment To Insight failed.
Status Code
The response code issued by the third-party API server or the D3 SOAR system that can be used to locate the corresponding error category. For example, if the returned status code is 401, the selected connection is unauthorized to run the command. The user or system support would need to check the permission setting in the Sumo Logic Cloud SIEM Enterprise (Sumo Logic CSE) portal. Refer to the HTTP Status Code Registry for details.
Status Code: 500.
Message
The raw data or captured key error message from the integration API server about the API request failure.
Message: INTERNAL_SERVER_ERROR.
Error Sample Data
Add Comment To Insight failed.
Status Code: 500.
Message: INTERNAL_SERVER_ERROR.
Add Suppress List Items To Suppress List
Adds the specified list items to a Suppress List.
READER NOTE
Suppress List ID is a required parameterto run this command.
Run the List Suppress Lists command to obtain the Suppress List IDs. Suppress List IDs can be found in the raw data at the path $.data.objects[*].id.
Input
Input Parameter
Required/Optional
Description
Example
Suppress List ID
Required
The ID of the Suppress List to which items will be added. Suppress List IDs can be obtained using the List Suppress Lists command.
*****
Suppress List Items
Required
The JSON array of items to add to the specified Suppress List. Each item must have the "active", "description", and "value" fields. The "expiration" field is optional. If left empty, the suppress list item will never expire. The field "Active" is a Boolean, and "value" is the name of the suppress list item. The expiration date cannot be earlier than the current time. Otherwise, the error message "Please input valid suppress list items" will be returned.
Indicates one of the possible command execution states: Successful or Failed.
The Failed state can be triggered by any of the following errors:
A connection issue with the integration
The API returned an error message
No response from the API
You can view more details about an error in the Error tab.
Return Data can be passed down directly to a subsequent command or used to create conditional tasks in playbooks.
SAMPLE DATA
CODE
Successful
Raw Data
The primary response data from the API request.
SAMPLE DATA
JSON
{
"data": {
"ok": true
},
"errors": []
}
Result
Provides a brief summary of outputs in an HTML formatted table.
SAMPLE DATA
ok
TRUE
Error Handling
If the Return Data is Failed, an Error tab will appear in the Test Result window.
The errortab contains the details responded from D3 SOAR or third-party API calls, including Failure Indicator, Status Code, and Message. This can help you locate the root cause of a command failure.
Parts in Error
Description
Example
Failure Indicator
Indicates the command failure that happened at a specific input and/or API call.
Add Suppress List Items To Suppress List failed.
Status Code
The response code issued by the third-party API server or the D3 SOAR system that can be used to locate the corresponding error category. For example, if the returned status code is 401, the selected connection is unauthorized to run the command. The user or system support would need to check the permission setting in the Sumo Logic Cloud SIEM Enterprise (Sumo Logic CSE) portal. Refer to the HTTP Status Code Registry for details.
Status Code: 400.
Message
The raw data or captured key error message from the integration API server about the API request failure.
Message: The value for parameter (Suppress List Items) is invalid.
Error Sample Data
Add Suppress List Items To Suppress List failed.
Status Code: 400.
Message: The value for parameter (Suppress List Items) is invalid..
Create Aggregation Rule
Creates an Aggregation Rule.
READER NOTE
Tuning Expression IDs is an optional parameter to run this command.
Run the List Rule Tuning Expressions command to obtain the Tuning Expression IDs. Tuning Expression IDscan be found in the raw data at the path $.data.objects[*].id.
Input
Input Parameter
Required/Optional
Description
Example
Aggregation Functions
Required
The JSON array of objects defining the functions of the Aggregation Rule. Each function must include "arguments", "function", and "name" fields. The "arguments" field is an array of strings and must be formatted correctly. The valid values for the "function" field are: avg, count, count_distinct, first, last, max, min, and sum.
The asset field of the Aggregation Rule. At least one of the Asset Field or Entity Selectors parameters must be defined.
device_ip
Description Expression
Required
The description expression for the Aggregation Rule.
This is a test aggregation rule.
Enabled
Optional
Whether to enable the Aggregation Rule. Available options are:
True
False
By default, the value is True.
True
Entity Selectors
Optional
The JSON array defining the entity selectors of the Aggregation Rule. Each entity selector must have the "entityType" and "expression" fields. Note that:
At least one of the Asset Field or Entity Selectors parameters must be defined.
The "entityType" field specifies the identifier for the type of Entity on which the Signal will be generated. It can be either one of the built-in entity types (_ip, _hostname, _mac, _username) or a custom entity type defined in the UI.
The “expression” field from the record contains the Entity value on which the Signal is generated.
Defines the score mapping of the Aggregation Rule. The score mapping "type" must be set to constant, fieldValue, or fieldValueMapping. The default score is an estimate of the criticality of the activity in question. It should be a rank between 0 (lowest) and 10 (highest). Signals with a severity value of 0 do not contribute to the Insight algorithm.
Test Aggregation Rule. AWS CloudTrail reconnaissance activity detected by user: user_username from source IP: srcDevice_ip
Tags
Optional
The tags for the Aggregation Rule.
JSON
[ "_mitreAttackTactic:TA0007" ]
Trigger Expression
Required
The trigger expression of the Aggregation Rule.
distinct_eventid_count > 9
Tuning Expression IDs
Optional
The tuning expression IDs for the Aggregation Rule. Tuning expression IDs can be obtained using the List Rule Tuning Expressions command. While global Rule Tuning Expressions apply to all rules, only the non-global tuning expressions must be retrieved.
JSON
[ "*****" ]
Window Size
Required
The length of time across which the Aggregation Rule is applied. Available options are:
CUSTOM
5 Days
5 Minutes
10 Minutes
12 Hours
24 Hours
30 Minutes
60 Minutes
This parameter will be set to CUSTOM (regardless of the input value) if the Window Size in Milliseconds parameter is defined.
CUSTOM
Window Size in Milliseconds
Optional
The length of time across which the Aggregation Rule is applied in milliseconds. This value can be defined when the Window Size parameter is set to CUSTOM. If this parameter is defined, the defined value for the Window Size parameter will be automatically set to CUSTOM.
600000
Output
Return Data
Indicates one of the possible command execution states: Successful or Failed.
The Failed state can be triggered by any of the following errors:
A connection issue with the integration
The API returned an error message
No response from the API
You can view more details about an error in the Error tab.
Return Data can be passed down directly to a subsequent command or used to create conditional tasks in playbooks.
If the Return Data is Failed, an Error tab will appear in the Test Result window.
The errortab contains the details responded from D3 SOAR or third-party API calls, including Failure Indicator, Status Code, and Message. This can help you locate the root cause of a command failure.
Parts in Error
Description
Example
Failure Indicator
Indicates the command failure that happened at a specific input and/or API call.
Create Aggregation Rule failed.
Status Code
The response code issued by the third-party API server or the D3 SOAR system that can be used to locate the corresponding error category. For example, if the returned status code is 401, the selected connection is unauthorized to run the command. The user or system support would need to check the permission setting in the Sumo Logic Cloud SIEM Enterprise (Sumo Logic CSE) portal. Refer to the HTTP Status Code Registry for details.
Status Code: 400.
Message
The raw data or captured key error message from the integration API server about the API request failure.
Message: rule name already exists.
Error Sample Data
Create Aggregation Rule failed.
Status Code: 400.
Message: rule name already exists.
Create Chain Rule
Creates a Chain Rule. A Chain Rule has multiple rule expressions (e.g. two or more types of events) that must be matched a certain number of times within a specified time window for the rule to fire a Signal.
READER NOTE
Tuning Expression IDs is an optional parameter to run this command.
Run the List Rule Tuning Expressions command to obtain the Tuning Expression IDs. Tuning Expression IDscan be found in the raw data at the path $.data.objects[*].id.
Input
Input Parameter
Required/Optional
Description
Example
Asset Field
Optional
The asset field of the Chain Rule. At least one of the Asset Field or Entity Selectors parameters must be defined.
user_username
Description
Required
The description for the Chain Rule.
TEST Desc. Chain Rule A
Enabled
Optional
Whether to enable the Chain Rule. Available options are:
True
False
By default, the value is True.
True
Entity Selectors
Optional
The JSON array defining the entity selectors of the Chain Rule. Each entity selector must have the "entityType" and "expression" fields. Note that:
At least one of the Asset Field or Entity Selectors parameters must be defined.
The "entityType" field specifies the identifier for the type of Entity on which the Signal will be generated. It can be either one of the built-in entity types (_ip, _hostname, _mac, _username) or a custom entity type defined in the UI.
The “expression” field from the record contains the Entity value on which the Signal is generated.
Whether the Chain Rule is a prototype. Available options are:
True
False
By default, the value is False.
True
Name
Required
The name of the Chain Rule.
TEST Chain Rule A1
Ordered
Optional
Whether matches must occur in the same order as the rule expressions are arranged. Available options are:
True
False
If True is selected, there must be two rule expressions, and matches must occur in the specified order. If False is selected, matches can occur in any order. By default, the value is False.
False
Parent Jask ID
Optional
The Parent Jask ID of the Chain Rule.
*****
Score
Required
Defines the score of the Chain Rule. The score is a measure of the criticality of the activity in question and should be ranked between 0 (lowest) and 10 (highest). Signals with a severity value of 0 do not affect the Insight algorithm.
1
Stream
Required
The stream of the Chain Rule.
record
Summary Expression
Optional
The summary expression of the Chain Rule.
Test Lateral movement detected to host
Tags
Optional
The tags for the Chain Rule.
JSON
[ "_mitreAttackTactic:TA0008" ]
Tuning Expression IDs
Optional
The tuning expression IDs for the Chain Rule. Tuning expression IDs can be obtained using the List Rule Tuning Expressions command. While Global Rule Tuning Expressions apply to all rules, only the non-global tuning expressions must be retrieved.
JSON
[ "*****" ]
Window Size
Required
The length of time across which the Chain Rule is applied. Available options are:
CUSTOM
5 Days
5 Minutes
10 Minutes
12 Hours
24 Hours
30 Minutes
60 Minutes
This parameter will be set to CUSTOM (regardless of the input value) if the Window Size in Milliseconds parameter is defined.
CUSTOM
Window Size in Milliseconds
Optional
The length of time across which the Chain Rule is applied in milliseconds. This value can be defined when the Window Size parameter is set to CUSTOM. If this paramete is defined, the defined value for the Window Size parameter will be automatically set to CUSTOM.
900000
Output
Return Data
Indicates one of the possible command execution states: Successful or Failed.
The Failed state can be triggered by any of the following errors:
A connection issue with the integration
The API returned an error message
No response from the API
You can view more details about an error in the Error tab.
Return Data can be passed down directly to a subsequent command or used to create conditional tasks in playbooks.
If the Return Data is Failed, an Error tab will appear in the Test Result window.
The errortab contains the details responded from D3 SOAR or third-party API calls, including Failure Indicator, Status Code, and Message. This can help you locate the root cause of a command failure.
Parts in Error
Description
Example
Failure Indicator
Indicates the command failure that happened at a specific input and/or API call.
Create Chain Rule failed.
Status Code
The response code issued by the third-party API server or the D3 SOAR system that can be used to locate the corresponding error category. For example, if the returned status code is 401, the selected connection is unauthorized to run the command. The user or system support would need to check the permission setting in the Sumo Logic Cloud SIEM Enterprise (Sumo Logic CSE) portal. Refer to the HTTP Status Code Registry for details.
Status Code: 400.
Message
The raw data or captured key error message from the integration API server about the API request failure.
Message: rule name already exists.
Error Sample Data
Create Chain Rule failed.
Status Code: 400.
Message: rule name already exists.
Create Custom Insight
Generates an Insight based on an Entity's Activity Score, which is the total severity of the unique Signals that have been triggered on the Entity over a certain time period. For more information aboutCustom Insights, see Configure a Custom Insight | Sumo Logic CSE Docs.
READER NOTE
Rule IDs is an optional parameter to run this command.
Run the List Rules command to obtain the Rule IDs. Rule IDs can be found in the raw data at the path $.data.objects[*].id
The name of the Custom Insight must be unique. Otherwise, the error message "Custom Insight Name Already Exists" will be returned.
Input
Input Parameter
Required/Optional
Description
Example
Description
Required
The description for the Custom Insight.
Custom insights description
Dynamic Severity
Optional
The JSON array defines the dynamic severity based on the severity of the Signals that will trigger the Insight. Each dynamic severity object must have the "insightSeverity"and "minimumSignalSeverity" fields. To use a constant severity, define it with the Constant Severity parameter.
Whether to enable the Custom Insight. Available options are:
True
False
True
Name
Required
The unique name of the Custom Insight.
Custom Insight with rule id
Ordered
Required
Whether Signals must occur in the exact order defined when multiple Signal expressions have been configured. If set to False, Signals will occur in any order. Available options are:
True
False
True
Rule IDs
Optional
The IDs of the rules for which a Custom Insight will be generated based on one or more rules firing Signals. Rule IDs can be obtained using the List Rules command. To have the Custom Insight be generated based on specific Signals, use the Signal Names parameter. Define either the Rule IDs or Signal Names parameter, but not both.
JSON
[ "*****" ]
Constant Severity
Required
The constant severity level. Available options are:
Low
Medium
High
Critical
To configure dynamic severity, use the Dynamic Severity parameter.
High
Signal Names
Optional
The names of the Signals that the Custom Insight will be generated based on. To have the Custom Insight be generated based on one or more rules firing Signals, define them with the Rule IDs parameter. Define either the Rule IDs or Signal Names parameters, but not both.
JSON
["signalName test"]
Tags
Optional
The tags for the Custom Insight.
JSON
[ "custom" ]
Output
Return Data
Indicates one of the possible command execution states: Successful or Failed.
The Failed state can be triggered by any of the following errors:
A connection issue with the integration
The API returned an error message
No response from the API
You can view more details about an error in the Error tab.
Return Data can be passed down directly to a subsequent command or used to create conditional tasks in playbooks.
If the Return Data is Failed, an Error tab will appear in the Test Result window.
The errortab contains the details responded from D3 SOAR or third-party API calls, including Failure Indicator, Status Code, and Message. This can help you locate the root cause of a command failure.
Parts in Error
Description
Example
Failure Indicator
Indicates the command failure that happened at a specific input and/or API call.
Create Custom Insight failed.
Status Code
The response code issued by the third-party API server or the D3 SOAR system that can be used to locate the corresponding error category. For example, if the returned status code is 401, the selected connection is unauthorized to run the command. The user or system support would need to check the permission setting in the Sumo Logic Cloud SIEM Enterprise (Sumo Logic CSE) portal. Refer to the HTTP Status Code Registry for details.
Status Code: 400.
Message
The raw data or captured key error message from the integration API server about the API request failure.
Message: CustomInsight Name Already Exists
Error Sample Data
Create Custom Insight failed.
Status Code: 400.
Message: CustomInsight Name Already Exists.
Create Insight From Signals
Creates an Insight from the specified Signals.
READER NOTE
Signal IDs is a required parameter to run this command.
Run the List Signals command to obtain the Signal IDs. Signal IDs can be found in the raw data at the path $.data.objects[*].id.
Input
Input Parameter
Required/Optional
Description
Example
Signal IDs
Required
The IDs of the Signals from which to create an Insight. Signal IDs can be obtained using the List Signals command.
JSON
[ "*****" ]
Output
Return Data
Indicates one of the possible command execution states: Successful or Failed.
The Failed state can be triggered by any of the following errors:
A connection issue with the integration
The API returned an error message
No response from the API
You can view more details about an error in the Error tab.
Return Data can be passed down directly to a subsequent command or used to create conditional tasks in playbooks.
Common cyber security indicators such as unique IDs, file hash values, CVE numbers, and IP addresses will be extracted from Raw Data as Key Fields.
The system stores these key fields in the path $.[playbookTask].outputData. You can use these key-value pairs as data points for playbook task inputs.
SAMPLE DATA
JSON
{
"InsightID": "*****",
"InsightName": "Unspecified Malicious Activity",
"Description": "Passes through an alert from an endpoint security product and adjusts the severity accordingly based on the severity provided in the log.",
"SignalIDs": [
"*****"
],
"SignalNames": [
"CrowdStrike Falcon - A process using Force Data Execution Prevention (Force DEP) tried to execute non-executable memory. The process was blocked."
]
}
Result
Provides a brief summary of outputs in an HTML formatted table.
SAMPLE DATA
data
{'artifacts': [], 'assignedTo': None, 'assignee': None, 'closed': None, 'closedBy': None, 'confidence': None, 'created': '2023-01-05T18:06:06.973556', 'description': 'Passes through an alert from an endpoint security product and adjusts the severity accordingly based on the severity provided in the log.', 'entity': {'entityType': '_username', 'hostname': None, 'id': '*****', 'macAddress': None, 'name': 'sysint', 'sensorZone': '', 'value': 'sysint'}, 'id': '*****', 'involvedEntities': [{'entityType': '_hostname', 'hostname': '*****', 'id': '*****', 'macAddress': None, 'name': '*****', 'sensorZone': '', 'value': '*****'}, {'entityType': '_ip', 'hostname': None, 'id': '_ip-***.***.***.***', 'macAddress': None, 'name': '***.***.***.***', 'sensorZone': '', 'value': '***.***.***.***'}, {'entityType': '_file', 'hostname': None, 'id': '*****', 'macAddress': None, 'name': 'dllhost.exe', 'sensorZone': '', 'value': 'dllhost.exe'}, {'entityType': '_hash', 'hostname': None, 'id': '*****', 'macAddress': None, 'name': '*****', 'sensorZone': '', 'value': '*****'}, {'entityType': '_hash', 'hostname': None, 'id': '*****', 'macAddress': None, 'name': '*****', 'sensorZone': '', 'value': '*****'}, {'entityType': '_file', 'hostname': None, 'id': '_file-\\Device\\HarddiskVolume4\\Windows\\SysWOW64', 'macAddress': None, 'name': '\\Device\\HarddiskVolume4\\Windows\\SysWOW64', 'sensorZone': '', 'value': '\\Device\\HarddiskVolume4\\Windows\\SysWOW64'}, {'entityType': '_username', 'hostname': None, 'id': '*****', 'macAddress': None, 'name': 'sysint', 'sensorZone': '', 'value': 'sysint'}], 'lastUpdated': '2023-01-05T18:06:06.973550', 'lastUpdatedBy': None, 'name': 'Unspecified Malicious Activity', 'orgId': '*****', 'readableId': 'INSIGHT-*****', 'resolution': None, 'severity': 'LOW', 'signals': [{'allRecords': [{'bro_dns_answers': [], 'bro_file_bytes': {}, 'bro_file_connUids': [], 'bro_flow_service': [], 'bro_ftp_pendingCommands': [], 'bro_http_cookieVars': [], 'bro_http_origFuids': [], 'bro_http_origMimeTypes': [], 'bro_http_request_headers': {}, 'bro_http_request_proxied': [], 'bro_http_response_headers': {}, 'bro_http_response_respFuids': [], 'bro_http_response_respMimeTypes': [], 'bro_http_tags': [], 'bro_http_uriVars': [], 'bro_kerberos_clientCert': {}, 'bro_kerberos_serverCert': {}, 'bro_sip_headers': {}, 'bro_sip_requestPath': [], 'bro_sip_responsePath': [], 'bro_ssl_certChainFuids': [], 'bro_ssl_clientCertChainFuids': [], 'cseSignal': {}, 'day': 4, 'description': 'A process using Force Data Execution Prevention (Force DEP) tried to execute non-executable memory. The process was blocked.', 'device_hostname': '*****', 'device_hostname_raw': '*****', 'device_ip': '***.***.***.***', 'device_ip_ipv4IntValue': *****, 'device_ip_isInternal': True, 'device_ip_version': 4, 'fieldTags': {}, 'fields': {'event.CommandLine': '*****', 'event.ComputerName': '*****', 'event.DetectDescription': 'A process using Force Data Execution Prevention (Force DEP) tried to execute non-executable memory. The process was blocked.', 'event.DetectId': '*****', 'event.DetectName': 'Blocked Exploit', 'event.FalconHostLink': 'https://*****.*****', 'event.FileName': 'dllhost.exe', 'event.FilePath': '\\Device\\HarddiskVolume4\\Windows\\SysWOW64', 'event.GrandparentCommandLine': 'C:\\WINDOWS\\system32\\services.exe', 'event.GrandparentImageFileName': '\\Device\\HarddiskVolume4\\Windows\\System32\\services.exe', 'event.LocalIP': '***.***.***.***', 'event.MACAddress': '***-***-***-***-***-***', 'event.MD5String': '*****', 'event.MachineDomain': '*****', 'event.Objective': 'Falcon Detection Method', 'event.ParentCommandLine': 'C:\\WINDOWS\\system32\\svchost.exe -k DcomLaunch -p', 'event.ParentImageFileName': '\\Device\\HarddiskVolume4\\Windows\\System32\\svchost.exe', 'event.ParentProcessId': '*****', 'event.PatternDispositionDescription': 'Prevention, operation blocked.', 'event.PatternDispositionFlags.BlockingUnsupportedOrDisabled': 'false', 'event.PatternDispositionFlags.BootupSafeguardEnabled': 'false', 'event.PatternDispositionFlags.CriticalProcessDisabled': 'false', 'event.PatternDispositionFlags.Detect': 'false', 'event.PatternDispositionFlags.FsOperationBlocked': 'false', 'event.PatternDispositionFlags.HandleOperationDowngraded': 'false', 'event.PatternDispositionFlags.InddetMask': 'false', 'event.PatternDispositionFlags.Indicator': 'false', 'event.PatternDispositionFlags.KillActionFailed': 'false', 'event.PatternDispositionFlags.KillParent': 'false', 'event.PatternDispositionFlags.KillProcess': 'false', 'event.PatternDispositionFlags.KillSubProcess': 'false', 'event.PatternDispositionFlags.OperationBlocked': 'true', 'event.PatternDispositionFlags.PolicyDisabled': 'false', 'event.PatternDispositionFlags.ProcessBlocked': 'false', 'event.PatternDispositionFlags.QuarantineFile': 'false', 'event.PatternDispositionFlags.QuarantineMachine': 'false', 'event.PatternDispositionFlags.RegistryOperationBlocked': 'false', 'event.PatternDispositionFlags.Rooting': 'false', 'event.PatternDispositionFlags.SensorOnly': 'false', 'event.PatternDispositionFlags.SuspendParent': 'false', 'event.PatternDispositionFlags.SuspendProcess': 'false', 'event.PatternDispositionValue': '1024', 'event.ProcessEndTime': '1672865973', 'event.ProcessId': '*****', 'event.ProcessStartTime': '1672865965', 'event.SHA1String': '*****', 'event.SHA256String': '*****', 'event.SensorId': '*****', 'event.Severity': '4', 'event.SeverityName': 'High', 'event.Tactic': 'Exploit', 'event.Technique': 'Exploit Mitigation', 'event.UserName': 'sysint', 'metadata.customerIDString': '*****', 'metadata.eventCreationTime': '1672865965000', 'metadata.eventType': 'DetectionSummaryEvent', 'metadata.offset': '2178627', 'metadata.version': '1.0'}, 'file_basename': 'dllhost.exe', 'file_hash_md5': '*****', 'file_hash_sha256': '*****', 'file_path': '\\Device\\HarddiskVolume4\\Windows\\SysWOW64', 'friendlyName': 'record', 'hour': 20, 'http_requestHeaders': {}, 'listMatches': [], 'matchedItems': [], 'metadata_deviceEventId': '*****', 'metadata_mapperName': 'CrowdStrike Falcon Host API DetectionSummaryEvent (CNC)', 'metadata_mapperUid': '*****', 'metadata_orgId': '*****', 'metadata_parseTime': 1672866226154, 'metadata_product': 'Falcon', 'metadata_productGuid': '*****', 'metadata_receiptTime': 1672866186, 'metadata_schemaVersion': 3, 'metadata_sensorId': '*****', 'metadata_sensorInformation': {}, 'metadata_sensorZone': 'default', 'metadata_sourceCategory': 'HTTP Collection', 'metadata_sourceMessageId': '*****', 'metadata_vendor': 'CrowdStrike', 'month': 1, 'normalizedSeverity': 6, 'objectType': 'Endpoint', 'severity': '4', 'threat_name': 'Blocked Exploit', 'threat_referenceUrl': 'https://*****.*****', 'threat_ruleType': 'direct', 'threat_signalName': 'A process using Force Data Execution Prevention (Force DEP) tried to execute non-executable memory. The process was blocked.', 'timestamp': 1672865965000, 'uid': '*****', 'user_username': 'sysint', 'user_username_raw': 'sysint', 'year': 2023}], 'artifacts': [], 'contentType': 'RULE', 'description': 'Passes through an alert from an endpoint security product and adjusts the severity accordingly based on the severity provided in the log.', 'id': '*****', 'name': 'CrowdStrike Falcon - A process using Force Data Execution Prevention (Force DEP) tried to execute non-executable memory. The process was blocked.', 'recordCount': 1, 'recordTypes': [], 'ruleId': 'MATCH-*****', 'severity': 6, 'stage': 'Unknown/Other', 'tags': [], 'timestamp': '2023-01-04T20:59:25'}], 'source': 'USER', 'status': {'displayName': 'New', 'name': 'new'}, 'subResolution': None, 'tags': [], 'teamAssignedTo': None, 'timeToDetection': 76001.973556, 'timeToRemediation': None, 'timeToResponse': None, 'timestamp': '2023-01-04T20:59:25'}
errors
[]
Error Handling
If the Return Data is Failed, an Error tab will appear in the Test Result window.
The errortab contains the details responded from D3 SOAR or third-party API calls, including Failure Indicator, Status Code, and Message. This can help you locate the root cause of a command failure.
Parts in Error
Description
Example
Failure Indicator
Indicates the command failure that happened at a specific input and/or API call.
Create Insight From Signals failed.
Status Code
The response code issued by the third-party API server or the D3 SOAR system that can be used to locate the corresponding error category. For example, if the returned status code is 401, the selected connection is unauthorized to run the command. The user or system support would need to check the permission setting in the Sumo Logic Cloud SIEM Enterprise (Sumo Logic CSE) portal. Refer to the HTTP Status Code Registry for details.
Status Code: 404.
Message
The raw data or captured key error message from the integration API server about the API request failure.
Message: Signals with the following ID(s) were not found.
Error Sample Data
Create Insight From Signals failed.
Status Code: 404.
Message: Signals with the following ID(s) were not found.
Create Legacy Match Rule
Creates a Legacy Match Rule.
READER NOTE
Tuning Expression IDs is an optional parameter to run this command.
Run the List Rule Tuning Expressions command to obtain the Tuning Expression IDs. Tuning Expression IDscan be found in the raw data at the path $.data.objects[*].id.
Input
Input Parameter
Required/Optional
Description
Example
Asset Field
Optional
The asset field of the Legacy Match Rule. At least one of the Asset Field or Entity Selectors parameters must be defined.
device_hostname
Description
Required
The description for the Legacy Match Rule.
Test Descr Legacy Match Rule A
Enabled
Optional
Whether to enable the Legacy Match Rule. Available options are:
True
False
By default, the value is True.
True
Entity Selectors
Optional
The JSON array defining the entity selectors of the Legacy Match Rule. Each entity selector must have the "entityType" and "expression" fields. Note that:
At least one of the Asset Field or Entity Selectors parameters must be defined.
The "entityType" field specifies the identifier for the type of Entity on which the Signal will be generated. It can be either one of the built-in entity types (_ip, _hostname, _mac, _username) or a custom entity type defined in the UI.
The “expression” field from the record contains the Entity value on which the Signal is generated.
lower(parentBaseImage) like '%winword.exe'\nAND lower(baseImage) like '%csc.exe'
Is Prototype
Optional
Whether the Legacy Match Rule is a prototype. Available options are:
True
False
By default, the value is False.
True
Name
Required
The name of the Legacy Match Rule.
Test Legacy Match Rule B
Parent Jask ID
Optional
The Parent Jask ID of the Legacy Match Rule.
*****
Score
Required
Defines the score of the Legacy Match Rule. The score is an estimate of the criticality of the activity in question. It should be a rank between 0 (lowest) and 10 (highest). Signals with a severity value of 0 do not contribute to the Insight algorithm.
10
Stream
Required
The stream of the Legacy Match Rule.
record
Summary Expression
Optional
The summary expression of the Legacy Match Rule.
TEST. Observed possible CVE-2017-8759 exploit on device_hostname
Tags
Optional
The tags for the Legacy Match Rule.
JSON
[ "_mitreAttackTactic:TA0002" ]
Tuning Expression IDs
Optional
The tuning expression IDs for the Legacy Match Rule. Tuning expression IDs can be obtained using the List Rule Tuning Expressions command. While Global Rule Tuning Expressions apply to all rules, only the non-global tuning expressions must be retrieved.
JSON
[ "*****" ]
Output
Return Data
Indicates one of the possible command execution states: Successful or Failed.
The Failed state can be triggered by any of the following errors:
A connection issue with the integration
The API returned an error message
No response from the API
You can view more details about an error in the Error tab.
Return Data can be passed down directly to a subsequent command or used to create conditional tasks in playbooks.
If the Return Data is Failed, an Error tab will appear in the Test Result window.
The errortab contains the details responded from D3 SOAR or third-party API calls, including Failure Indicator, Status Code, and Message. This can help you locate the root cause of a command failure.
Parts in Error
Description
Example
Failure Indicator
Indicates the command failure that happened at a specific input and/or API call.
Create Legacy Match Rule failed.
Status Code
The response code issued by the third-party API server or the D3 SOAR system that can be used to locate the corresponding error category. For example, if the returned status code is 401, the selected connection is unauthorized to run the command. The user or system support would need to check the permission setting in the Sumo Logic Cloud SIEM Enterprise (Sumo Logic CSE) portal. Refer to the HTTP Status Code Registry for details.
Status Code: 404.
Message
The raw data or captured key error message from the integration API server about the API request failure.
Message: Tuning Expression with the following ID(s) were not found.
Error Sample Data
Create Legacy Match Rule failed.
Status Code: 404.
Message: Tuning Expression with the following ID(s) were not found.
Create or Update Signal Enrichments
Creates or updates enrichments for the specified Signals.
READER NOTE
Signal IDs is a required parameterto run this command.
Run the List Signals command to obtain the Signal IDs. Signal IDs can be found in the raw data at the path $.data.objects[*].id.
Input
Input Parameter
Required/Optional
Description
Example
Signal IDs
Required
The IDs of the Signals to create or update enrichments. Signal IDs can be obtained using the List Signals command.
Indicates one of the possible command execution states: Successful, Partially Successful, or Failed.
The Partially Successful state only occurs when a command’s input accepts an array of items (e.g. an array of IP addresses) and one or more items within the array return an error from the API request.
The Failed state can be triggered by any of the following errors:
A connection issue with the integration
The API returned an error message
No response from the API
You can view more details about an error in the Error tab.
Return Data can be passed down directly to a subsequent command or used to create conditional tasks in playbooks.
If the Return Data is Partially Successful or Failed, an Error tab will appear in the Test Result window.
The errortab contains the details responded from D3 SOAR or third-party API calls, including Failure Indicator, Status Code, and Message. This can help you locate the root cause of a command failure.
Parts in Error
Description
Example
Failure Indicator
Indicates the command failure that happened at a specific input and/or API call.
Create or Update Signal Enrichments failed.
Status Code
The response code issued by the third-party API server or the D3 SOAR system that can be used to locate the corresponding error category. For example, if the returned status code is 401, the selected connection is unauthorized to run the command. The user or system support would need to check the permission setting in the Sumo Logic Cloud SIEM Enterprise (Sumo Logic CSE) portal. Refer to the HTTP Status Code Registry for details.
Status Code: 404.
Message
The raw data or captured key error message from the integration API server about the API request failure.
Message: Signal with ID=xxx not found.
Error Sample Data
Create or Update Signal Enrichments failed.
Status Code: 404.
Message: Signal with ID=xxx not found.
Create Rule Tuning Expression
Creates a Rule Tuning Expression.
READER NOTE
Rule IDs is an optional parameter to run this command.
Run the List Rules command to obtain the Rule IDs. Rule IDs can be found in the raw data at the path $.data.objects[*].id.
Input
Input Parameter
Required/Optional
Description
Example
Name
Required
The name for the Rule Tuning Expression.
RTE-0106a
Description
Required
The description for the Rule Tuning Expression.
TEST0106
Enabled
Required
Whether to enable the Rule Tuning Expression. Available options are:
True
False
True
Include Or Exclude
Required
Whether to include or exclude records matching the expression.
Exclude
Is Global
Required
Whether the Rule Tuning Expression is global (True) or only applies to the selected rules (False).
False
Rule IDs
Optional
The IDs of the rules to apply the Rule Tuning Expression. Rule IDs can be obtained using the List Rules command.This parameter is required when the Is Global parameter is False.
JSON
["*****"]
Expression
Required
The Rule Tuning Expression statement.
user_username=sysint
Output
Return Data
Indicates one of the possible command execution states: Successful or Failed.
The Failed state can be triggered by any of the following errors:
A connection issue with the integration
The API returned an error message
No response from the API
You can view more details about an error in the Error tab.
Return Data can be passed down directly to a subsequent command or used to create conditional tasks in playbooks.
Provides a brief summary of outputs in an HTML formatted table.
SAMPLE DATA
description
TEST0106
enabled
TRUE
exclude
TRUE
expression
user_username=sysint
id
*****
isGlobal
FALSE
name
RTE-0106a
Error Handling
If the Return Data is Failed, an Error tab will appear in the Test Result window.
The errortab contains the details responded from D3 SOAR or third-party API calls, including Failure Indicator, Status Code, and Message. This can help you locate the root cause of a command failure.
Parts in Error
Description
Example
Failure Indicator
Indicates the command failure that happened at a specific input and/or API call.
Create Rule Tuning Expression failed.
Status Code
The response code issued by the third-party API server or the D3 SOAR system that can be used to locate the corresponding error category. For example, if the returned status code is 401, the selected connection is unauthorized to run the command. The user or system support would need to check the permission setting in the Sumo Logic Cloud SIEM Enterprise (Sumo Logic CSE) portal. Refer to the HTTP Status Code Registry for details.
Status Code: 404.
Message
The raw data or captured key error message from the integration API server about the API request failure.
Message: Rule with ID=xxx not found.
Error Sample Data
Create Rule Tuning Expression failed.
Status Code: 404.
Message: Rule with ID=xxx not found.
Create Templated Match Rule
Creates a Templated Match Rule.
READER NOTE
Tuning Expression IDs is an optional parameter to run this command.
Run the List Rule Tuning Expressions command to obtain the Tuning Expression IDs. Tuning Expression IDscan be found in the raw data at the path $.data.objects[*].id.
Input
Input Parameter
Required/Optional
Description
Example
Asset Field
Optional
The asset field of the Templated Match Rule. At least one of the Asset Field or Entity Selectors parameters must be defined.
device_hostname
Description Expression
Required
The description expression for the Templated Match Rule.
TEST desc. Templated Match Rule A
Enabled
Optional
Whether to enable the Templated Match Rule. Available options are:
True
False
By default, the value is True.
True
Entity Selectors
Optional
The JSON array defining the entity selectors of the Templated Match Rule. Each entity selector must have the "entityType" and "expression" fields. Note that:
At least one of the Asset Field or Entity Selectors parameters must be defined.
The "entityType" field specifies the identifier for the type of Entity on which the Signal will be generated. It can be either one of the built-in entity types (_ip, _hostname, _mac, _username) or a custom entity type defined in the UI.
The “expression” field from the record contains the Entity value on which the Signal is generated.
baseImage like '%.exe'\nAND lower(commandLine) like '%-dc%'\nAND lower(commandLine) like '%-domain%'\nAND lower(commandLine) like '%-action%'\nAND \n(\n lower(commandLine) like '%gpp'\nOR lower(commandLine) like '%ad'\n)
Is Prototype
Optional
Whether the Templated Match Rule is a prototype. Available options are:
True
False
By default, the value is False.
True
Name
Required
The name of the Templated Match Rule.
TEST Templated Match Rule A
Name Expression
Required
The name expression of the Templated Match Rule.
TEST Templated Match Rule A. FireEye ADPassHunt Tool
Parent Jask ID
Optional
The Parent Jask ID of the Templated Match Rule.
*****
Score Mapping
Required
Defines the score mapping of the templated match rule. The score mapping “type” must be set to constant, fieldValue, or fieldValueMapping. The default score is an estimate of the criticality of the activity in question. It should be a rank between 0 (lowest) and 10 (highest). Signals with a severity value of 0 do not contribute to the Insight algorithm.
The summary expression of the Templated Match Rule.
ADPassHunt (credential stealer) tool associated command line arguments detected on host
Tags
Optional
The tags for the Templated Match Rule.
JSON
[ "_mitreAttackTactic:TA0006" ]
Tuning Expression IDs
Optional
The Tuning Expression IDs for the Templated Match Rule. Tuning Expression IDs can be obtained using the List Rule Tuning Expressions command. While global Rule Tuning Expressions apply to all rules, only the non-global tuning expressions must be retrieved.
JSON
[ "*****" ]
Output
Return Data
Indicates one of the possible command execution states: Successful or Failed.
The Failed state can be triggered by any of the following errors:
A connection issue with the integration
The API returned an error message
No response from the API
You can view more details about an error in the Error tab.
Return Data can be passed down directly to a subsequent command or used to create conditional tasks in playbooks.
If the Return Data is Failed, an Error tab will appear in the Test Result window.
The errortab contains the details responded from D3 SOAR or third-party API calls, including Failure Indicator, Status Code, and Message. This can help you locate the root cause of a command failure.
Parts in Error
Description
Example
Failure Indicator
Indicates the command failure that happened at a specific input and/or API call.
Create Templated Match Rule failed.
Status Code
The response code issued by the third-party API server or the D3 SOAR system that can be used to locate the corresponding error category. For example, if the returned status code is 401, the selected connection is unauthorized to run the command. The user or system support would need to check the permission setting in the Sumo Logic Cloud SIEM Enterprise (Sumo Logic CSE) portal. Refer to the HTTP Status Code Registry for details.
Status Code: 404.
Message
The raw data or captured key error message from the integration API server about the API request failure.
Message: Tuning Expression with the following ID(s) were not found.
Error Sample Data
Create Templated Match Rule failed.
Status Code: 404.
Message: Tuning Expression with the following ID(s) were not found.
Create Threshold Rule
Creates a Threshold Rule. A Threshold Rule is triggered when the rule expression is met at least a certain number of times during a specified period of time.
READER NOTE
Tuning Expression IDs is an optional parameter to run this command.
Run the List Rule Tuning Expressions command to obtain the Tuning Expression IDs. Tuning Expression IDs can be found in the raw data at the path $.data.objects[*].id.
Input
Input Parameter
Required/Optional
Description
Example
Asset Field
Optional
The asset field of the Threshold Rule. At least one of the Asset Field or Entity Selectors parameters must be defined.
device_ip
Count Distinct
Required
Whether to count only unique values for a field. This allows the rule to count the number of records with distinct values for a specific field instead of simply counting records that match the rule expression. Available options are:
True
False
Use the Count Field parameter to select the field of interest.
True
Count Field
Optional
The field to use for counting the number of records with distinct values. This parameter is required when the Count Distinct parameter is set to True. If Count Distinct is set to False, this parameter will be ignored.
action
Description
Required
The description for the Threshold Rule.
TEST Desc. Threshold Rule A
Enabled
Optional
Whether to enable the Threshold Rule. Available options are:
True
False
By default, the value is True.
True
Entity Selectors
Optional
The JSON array defining the entity selectors of the Threshold Rule. Each entity selector must have the "entityType" and "expression" fields. Note that:
At least one of the Asset Field or Entity Selectors parameters must be defined.
The "entityType" field specifies the identifier for the type of Entity on which the Signal will be generated. It can be either one of the built-in entity types (_ip, _hostname, _mac, _username) or a custom entity type defined in the UI.
The “expression” field from the record contains the Entity value on which the Signal is generated.
The input string that includes the boolean expression which triggers the Threshold Rule to fire if the Enabled parameter is set to True.
metadata_vendor = 'Amazon AWS'\nAND metadata_product = 'CloudTrail'\nAND fields['errorCode'] = 'AccessDenied'\nAND fields['userIdentity.arn'] like '%:iam:%'\nAND device_ip != 'AWS Internal'\nAND device_ip not like '%.amazonaws.com'
Group By Fields
Optional
The fields to group the Threshold Rule by.
JSON
[ "id" ]
Is Prototype
Optional
Whether the Threshold Rule is a prototype. Available options are:
True
False
By default, the value is False.
True
Limit
Required
The number of records that must match the rule expression within the specified time interval for the Threshold Rule to trigger.
10
Name
Required
The name of the Threshold Rule.
TEST Threshold Rule A
Parent Jask ID
Optional
The Parent Jask ID of the Threshold Rule.
*****
Score
Required
Defines the score of the Threshold rule. The score is an estimate of the criticality of the activity in question. It should be a rank between 0 (lowest) and 10 (highest). Signals with a severity value of 0 do not contribute to the Insight algorithm.
1
Stream
Required
The stream of the Threshold Rule.
record
Summary Expression
Optional
The summary expression of the Threshold Rule.
TEST. AWS API Call attempts denied by user
Tags
Optional
The tags for the Threshold Rule.
JSON
[ "_mitreAttackTactic:TA0006" ]
Tuning Expression IDs
Optional
The tuning expression IDs for the Threshold Rule. Tuning expression IDs can be obtained using the List Rule Tuning Expressions command. While global Rule Tuning Expressions apply to all rules, only the non-global tuning expressions must be retrieved.
JSON
[ "*****" ]
Version
Required
The version number of the Threshold Rule.
1
Window Size
Required
The length of time across which the threshold rule is applied. Available options are:
CUSTOM
5 Days
5 Minutes
10 Minutes
12 Hours
24 Hours
30 Minutes
60 Minutes
This parameter will be set to CUSTOM (regardless of the input value) if the Window Size in Milliseconds parameter is defined.
CUSTOM
Window Size in Milliseconds
Optional
The length of time across which the threshold rule is applied in milliseconds. This value can be defined when the Window Size parameter is set to CUSTOM. If this parameter is defined, the defined value for the Window Size parameter will be automatically set to CUSTOM.
1200000
Output
Return Data
Indicates one of the possible command execution states: Successful or Failed
The Failed state can be triggered by any of the following errors:
A connection issue with the integration
The API returned an error message
No response from the API
You can view more details about an error in the Error tab.
Return Data can be passed down directly to a subsequent command or used to create conditional tasks in playbooks.
If the Return Data is Failed, an Error tab will appear in the Test Result window.
The errortab contains the details responded from D3 SOAR or third-party API calls, including Failure Indicator, Status Code, and Message. This can help you locate the root cause of a command failure.
Parts in Error
Description
Example
Failure Indicator
Indicates the command failure that happened at a specific input and/or API call.
Create Threshold Rule failed.
Status Code
The response code issued by the third-party API server or the D3 SOAR system that can be used to locate the corresponding error category. For example, if the returned status code is 401, the selected connection is unauthorized to run the command. The user or system support would need to check the permission setting in the Sumo Logic Cloud SIEM Enterprise (Sumo Logic CSE) portal. Refer to the HTTP Status Code Registry for details.
Status Code: 404.
Message
The raw data or captured key error message from the integration API server about the API request failure.
Message: Tuning Expression with the following ID(s) were not found.
Error Sample Data
Create Threshold Rule failed.
Status Code: 404.
Message: Tuning Expression with the following ID(s) were not found.
Delete Match List Items
Deletes Match List Items using the given Match List Item IDs.
READER NOTE
Match List Item IDs is a required parameterto run this command.
Run the List Match List Items command to obtain the Match List Item IDs. Match List Item IDs can be found in the raw data at the path $.data.objects[*].id.
Input
Input Parameter
Required/Optional
Description
Example
Match List Item IDs
Required
The IDs of the Match List Items to delete. Match List Item IDs can be obtained using the List Match List Items command.
JSON
[ "*****" ]
Output
Return Data
Indicates one of the possible command execution states: Successful, Partially Successful, or Failed.
The Partially Successful state only occurs when a command’s input accepts an array of items (e.g. an array of IP addresses) and one or more items within the array return an error from the API request.
The Failed state can be triggered by any of the following errors:
A connection issue with the integration
The API returned an error message
No response from the API
You can view more details about an error in the Error tab.
Return Data can be passed down directly to a subsequent command or used to create conditional tasks in playbooks.
Provides a brief summary of outputs in an HTML formatted table.
SAMPLE DATA
data
errors
{'id': '*****', 'ok': True}
[]
Error Handling
If the Return Data is Partially Successful or Failed, an Error tab will appear in the Test Result window.
The errortab contains the details responded from D3 SOAR or third-party API calls, including Failure Indicator, Status Code, and Message. This can help you locate the root cause of a command failure.
Parts in Error
Description
Example
Failure Indicator
Indicates the command failure that happened at a specific input and/or API call.
Delete Match List Items failed.
Status Code
The response code issued by the third-party API server or the D3 SOAR system that can be used to locate the corresponding error category. For example, if the returned status code is 401, the selected connection is unauthorized to run the command. The user or system support would need to check the permission setting in the Sumo Logic Cloud SIEM Enterprise (Sumo Logic CSE) portal. Refer to the HTTP Status Code Registry for details.
Status Code: 404.
Message
The raw data or captured key error message from the integration API server about the API request failure.
Message: Match List Item with the following ID(s) were not found.
Error Sample Data
Delete Match List Items failed.
Status Code: 404.
Message: Match List Item with the following ID(s) were not found.
Delete Suppress List Items
Deletes Suppress List Items using the given Suppress List Item IDs.
READER NOTE
Suppress List Item IDs is a required parameter to run this command.
Run the List Suppress List Items command to obtain the Suppress List Item IDs. Suppress List IDs can be found in the raw data at the path $.data.objects[*].id.
Input
Input Parameter
Required/Optional
Description
Example
Suppress List Item IDs
Required
The IDs of the Suppress List Items to delete. Suppress List Item IDs can be obtained using the List Suppress List Items command.
JSON
[ "*****" ]
Output
Return Data
Indicates one of the possible command execution states: Successful, Partially Successful, or Failed.
The Partially Successful state only occurs when a command’s input accepts an array of items (e.g. an array of IP addresses) and one or more items within the array return an error from the API request.
The Failed state can be triggered by any of the following errors:
A connection issue with the integration
The API returned an error message
No response from the API
You can view more details about an error in the Error tab.
Return Data can be passed down directly to a subsequent command or used to create conditional tasks in playbooks.
Provides a brief summary of outputs in an HTML formatted table.
SAMPLE DATA
data
errors
{'id': '*****', 'ok': True}
[]
Error Handling
If the Return Data is Partially Successful or Failed, an Error tab will appear in the Test Result window.
The errortab contains the details responded from D3 SOAR or third-party API calls, including Failure Indicator, Status Code, and Message. This can help you locate the root cause of a command failure.
Parts in Error
Description
Example
Failure Indicator
Indicates the command failure that happened at a specific input and/or API call.
Delete Suppress List Items failed.
Status Code
The response code issued by the third-party API server or the D3 SOAR system that can be used to locate the corresponding error category. For example, if the returned status code is 401, the selected connection is unauthorized to run the command. The user or system support would need to check the permission setting in the Sumo Logic Cloud SIEM Enterprise (Sumo Logic CSE) portal. Refer to the HTTP Status Code Registry for details.
Status Code: 404.
Message
The raw data or captured key error message from the integration API server about the API request failure.
Message: A Suppress List Item with id=xxx could not be found.
Error Sample Data
Delete Suppress List Items failed.
Status Code: 404.
Message: A Suppress List Item with id=xxx could not be found.
Fetch Event
Retrieves Insights from Sumo Logic CSE based on the specified criteria.
READER NOTE
For the syntax of the Search Condition parameter, refer to the Sumo Logic CSE API reference. A screenshot of the reference is provided below.
Instead of using tolerance scope, it is recommended to check the Initiate the buffer time of the Data Reacquire for [x] minutes after completing the event fetch checkbox when setting up a new Data Ingestion schedule.
1. Navigate to Configuration > Data Ingestion.
2. Add a New Schedule Data Source for the Sumo Logic Cloud SIEM Enterprise (Sumo Logic CSE) Integration and check the Initiate the buffer time of the Data Reacquire for [x] minutes after completing the event fetch checkbox. Optionally, adjust the buffer time as necessary.
If no input parameters are defined, all events will be returned and fetched by the Original Time (the “timestamp” key in the response data) and the Insight Created Time (the “created” key in the response data).
Input
Input Parameter
Required/Optional
Description
Example
Start Time
Optional
The start of the time range (in UTC) to fetch events.
2023-01-04 00:00
End Time
Optional
The end of the time range (in UTC) to fetch events.
2023-01-05 00:00
Number of Event(s) Fetched
Optional
The maximum number of events to fetch. If the value is 0, a negative number, or not specified, the command will return all events within the defined time range.
The offset index of the returning results. This parameter will be ignored if the input value for the Number of Event(s) parameter is 0, a negative number, or not specified. By default, the value is 0.
0
Time Filter Field
Optional
The time filter field to fetch events. Available options are:
Original Time (“timestamp” key in the response data)
Insight Created Time (“created” key in the response data)
Insight Closed Time (“closed”key in the response data)
By default, the value is Insight Created Time. This parameter will be ignored if the Use D3 Default Time Filter parameter is set to True.
Original Timestamp
Use D3 Default Time Filter
Optional
Whether to use the D3 default time filter to fetch events. Available options are:
True
False
Setting this parameter to True will apply the Original Time (“timestamp” key in the response data) and Insight Created Time (“created” key in the response data) time filters. In this case, the Time Filter Field parameter will be ignored. By default, the value is True.
False
Record Summary Fields
Optional
A list of fields (excluding subfields) to aggregate from each Insight's records into a summarized list directly on the Insight object in the response.
JSON
[ "id" ]
Tolerance Scope
Optional
Note: Instead of using tolerance scope, it is recommended to check the Initiate the buffer time of the Data Reacquire for [x] minutes after completing the event fetch checkbox when setting up a new Data Ingestion schedule. Refer to the Reader Note for more information.
A time window (in minutes) that extends the time range for fetching events by subtracting from the specified start time. Tolerance scope helps prevent data loss by accounting for API response delays caused by temporary server-side data unavailability—arising from processing and synchronization—from the vendor. With the tolerance scope applied, events will be fetched within the range of (Start Time - Tolerance Scope) to End Time. By default, the tolerance scope is set to 0.
3
Output
Return Data
Indicates one of the possible command execution states: Successful, Successful with No Event Data, or Failed.
The Failed state can be triggered by any of the following errors:
A connection issue with the integration
The API returned an error message
No response from the API
You can view more details about an error in the Error tab.
Return Data can be passed down directly to a subsequent command or used to create conditional tasks in playbooks.
Please note that Fetch Event commands require event field mapping. Field mapping plays a key role in the data normalization process part of the event pipeline. Field mapping converts the original data fields from the different providers to the D3 fields which are standardized by the D3 Model. Please refer to Event and Incident Intake Field Mapping for details.
If you require a custom field mapping, click +Add Field to add a custom field mapping. You may also remove built-in field mappings by clicking x. Please note that two underscore characters will automatically prefix the defined Field Name as the System Name for a custom field mapping. Additionally, if an input Field Name contains any spaces, they will automatically be replaced with underscores for the corresponding System Name.
As a system integration, the Sumo Logic Cloud SIEM Enterprise (Sumo Logic CSE) integration has some pre-configured field mappings for default field mapping.
Default Event Source
The Default Event Source is the default set of field mappings that are applied when this fetch event command is executed. For out-of-the-box integrations, you will find a set of field mapping provided by the system. Default event source provides field mappings for common fields from fetched events. The default event source has a “Main Event JSON Path” (i.e., $.data.objects) that is used to extract a batch of events from the response raw data. Click Edit Main JSON Path to view the “Main Event JSON Path”.
Main Event JSON Path: $.data.objects
The Main Event JSON Path determines the root path where the system starts parsing raw response data into D3 event data. The JSON path begins with $, representing the root element. The path is formed by appending a sequence of child elements to $, each separated by a dot (.). Square brackets with nested quotation marks (['...']) should be used to separate child elements in JSON arrays.
For example, the root node of a JSON Path is data.objects. The child node denoting the Unique Event Key field would be id. Putting it together, the JSON Path expression to extract the Unique Event Key is $.data.objects[*].id.
The pre-configured field mappings are detailed below:
Field Name
Source Field
Unique Event Key
.id
Event Type
.name
Severity
.severity
Status
.status.displayName
Description
.description
Start Time
.timestamp
Created Time
.created
Updated Time
.lastUpdated
Closed Time
.closed
Event Name
.name
Organization ID
.orgId
Source type
.source
Readable ID
.readableId
Signal Names
.signals[*].name
Signal IDs
.signals[*].id
Signal Stages
.signals[*].stage
Signal Severities
.signals[*].severity
Entity Type
.entity.entityType
Device
.artifacts[?(@.name=='device_hostname')].value
Hostname
.entity.hostname
Username
.artifacts[?(@.name=='user_username')].value
Destination IP address
.artifacts[?(@.name=='dstDevice_ip')].value
Source IP address
.artifacts[?(@.name=='srcDevice_ip')].value
Threat Name
.artifacts[?(@.name=='threat_name')].value
Source Hostname
.artifacts[?(@.name=='srcDevice_hostname')].value
Error Handling
If the Return Data is Successful with No Event Data or Failed, an Error tab will appear in the Test Result window.
The errortab contains the details responded from D3 SOAR or third-party API calls, including Failure Indicator, Status Code, and Message. This can help you locate the root cause of a command failure.
Parts in Error
Description
Example
Failure Indicator
Indicates the command failure that happened at a specific input and/or API call.
Fetch Event failed.
Status Code
The response code issued by the third-party API server or the D3 SOAR system that can be used to locate the corresponding error category. For example, if the returned status code is 401, the selected connection is unauthorized to run the command. The user or system support would need to check the permission setting in the Sumo Logic Cloud SIEM Enterprise (Sumo Logic CSE) portal. Refer to the HTTP Status Code Registry for details.
Status Code: 401.
Message
The raw data or captured key error message from the integration API server about the API request failure.
Message: access_declined.
Error Sample Data
Fetch Event failed.
Status Code: 401.
Message: access_declined.
Get Custom Match List Columns
Retrieves Custom Match List columns using the given Custom Match List Column IDs.
READER NOTE
Custom Match List Column IDs is a required parameter to run this command.
Run the List Custom Match List Columns command to obtain the Custom Match List Column IDs. Custom Match List Column IDs can be found in the raw data at the path $.data[*].id.
Input
Input Parameter
Required/Optional
Description
Example
Custom Match List Column IDs
Required
The IDs of the Custom Match List columns to retrieve. Custom Match List Column IDs can be obtained using the List Custom Match List Columns command.
JSON
[
"*****",
"*****"
]
Output
Return Data
Indicates one of the possible command execution states: Successful or Failed.
The Failed state can be triggered by any of the following errors:
A connection issue with the integration
The API returned an error message
No response from the API
You can view more details about an error in the Error tab.
Return Data can be passed down directly to a subsequent command or used to create conditional tasks in playbooks.
Common cyber security indicators such as unique IDs, file hash values, CVE numbers, and IP addresses will be extracted from Raw Data as Key Fields.
The system stores these key fields in the path $.[playbookTask].outputData. You can use these key-value pairs as data points for playbook task inputs.
SAMPLE DATA
JSON
{
"CustomMatchListColumnIDs": [
"*****",
"*****"
],
"CustomMatchListColumnNames": [
"Custom Match List Column Test",
"Custom Match List Column 1"
]
}
Result
Provides a brief summary of outputs in an HTML formatted table.
SAMPLE DATA
data
errors
{'fields': ['action', 'accountId'], 'id': '*****', 'name': 'Custom Match List Column Test'}
[]
{'fields': ['authProvider', 'baseImage', 'action'], 'id': '*****', 'name': 'Custom Match List Column 1'}
[]
Error Handling
If the Return Data is Failed, an Error tab will appear in the Test Result window.
The errortab contains the details responded from D3 SOAR or third-party API calls, including Failure Indicator, Status Code, and Message. This can help you locate the root cause of a command failure.
Parts in Error
Description
Example
Failure Indicator
Indicates the command failure that happened at a specific input and/or API call.
Get Custom Match List Columns failed.
Status Code
The response code issued by the third-party API server or the D3 SOAR system that can be used to locate the corresponding error category. For example, if the returned status code is 401, the selected connection is unauthorized to run the command. The user or system support would need to check the permission setting in the Sumo Logic Cloud SIEM Enterprise (Sumo Logic CSE) portal. Refer to the HTTP Status Code Registry for details.
Status Code: 404.
Message
The raw data or captured key error message from the integration API server about the API request failure.
Message: Custom Match List Column with the following ID(s) were not found.
Error Sample Data
Get Custom Match List Columns failed.
Status Code: 404.
Message: Custom Match List Column with the following ID(s) were not found.
Get Insight Comments
Retrieves Insight comments using the given Insight IDs.
READER NOTE
Insight IDs is a required parameterto run this command.
Run the Fetch Event command to obtain the Insight IDs. Insight IDs can be found in the raw data at the path $.data.objects[*].id.
Input
Input Parameter
Required/Optional
Description
Example
Insight IDs
Required
The IDs of the Insights for which to retrieve comments. Insight IDs can be obtained using the Fetch Event command.
JSON
[ "*****" ]
Output
Return Data
Indicates one of the possible command execution states: Successful, Partially Successful, or Failed.
The Partially Successful state only occurs when a command’s input accepts an array of items (e.g. an array of IP addresses) and one or more items within the array return an error from the API request.
The Failed state can be triggered by any of the following errors:
A connection issue with the integration
The API returned an error message
No response from the API
You can view more details about an error in the Error tab.
Return Data can be passed down directly to a subsequent command or used to create conditional tasks in playbooks.
If the Return Data is Partially Successful or Failed, an Error tab will appear in the Test Result window.
The errortab contains the details responded from D3 SOAR or third-party API calls, including Failure Indicator, Status Code, and Message. This can help you locate the root cause of a command failure.
Parts in Error
Description
Example
Failure Indicator
Indicates the command failure that happened at a specific input and/or API call.
Get Insight Comments failed.
Status Code
The response code issued by the third-party API server or the D3 SOAR system that can be used to locate the corresponding error category. For example, if the returned status code is 401, the selected connection is unauthorized to run the command. The user or system support would need to check the permission setting in the Sumo Logic Cloud SIEM Enterprise (Sumo Logic CSE) portal. Refer to the HTTP Status Code Registry for details.
Status Code: 404.
Message
The raw data or captured key error message from the integration API server about the API request failure.
Message: Insight with the following ID(s) were not found.
Error Sample Data
Get Insight Comments failed.
Status Code: 404.
Message: Insight with the following ID(s) were not found.
Get Insight Enrichments
Retrieves enrichments from Insights using the given Insight IDs.
READER NOTE
Insight IDs is a required parameter to run this command.
Run the Fetch Event command to obtain the Insight IDs. Insight IDs can be found in the raw data at the path $.data.objects[*].id.
Input
Input Parameter
Required/Optional
Description
Example
Insight IDs
Required
The IDs of the Insights for which to retrieve enrichments. Insight IDs can be obtained using the Fetch Event command.
JSON
[ "*****" ]
Output
Return Data
Indicates one of the possible command execution states: Successful, Partially Successful, or Failed.
The Partially Successful state only occurs when a command’s input accepts an array of items (e.g. an array of IP addresses) and one or more items within the array return an error from the API request.
The Failed state can be triggered by any of the following errors:
A connection issue with the integration
The API returned an error message
No response from the API
You can view more details about an error in the Error tab.
Return Data can be passed down directly to a subsequent command or used to create conditional tasks in playbooks.
If the Return Data is Partially Successful or Failed, an Error tab will appear in the Test Result window.
The errortab contains the details responded from D3 SOAR or third-party API calls, including Failure Indicator, Status Code, and Message. This can help you locate the root cause of a command failure.
Parts in Error
Description
Example
Failure Indicator
Indicates the command failure that happened at a specific input and/or API call.
Get Insight Enrichments failed.
Status Code
The response code issued by the third-party API server or the D3 SOAR system that can be used to locate the corresponding error category. For example, if the returned status code is 401, the selected connection is unauthorized to run the command. The user or system support would need to check the permission setting in the Sumo Logic Cloud SIEM Enterprise (Sumo Logic CSE) portal. Refer to the HTTP Status Code Registry for details.
Status Code: 404.
Message
The raw data or captured key error message from the integration API server about the API request failure.
Message: Insight with the following ID(s) were not found.
Error Sample Data
Get Insight Enrichments failed.
Status Code: 404.
Message: Insight with the following ID(s) were not found.
Get Insight Entities
Retrieves involved entities of Insights using the given Insight IDs.
READER NOTE
Insight IDs is a required parameter to run this command.
Run the Fetch Event command to obtain the Insight IDs. Insight IDs can be found in the raw data at the path $.data.objects[*].id.
Input
Input Parameter
Required/Optional
Description
Example
Insight IDs
Required
The IDs of the Insights for which to retrieve involved entities. Insight IDs can be obtained using the Fetch Event command.
JSON
[ "*****" ]
Output
Return Data
Indicates one of the possible command execution states: Successful, Partially Successful, or Failed.
The Partially Successful state only occurs when a command’s input accepts an array of items (e.g. an array of IP addresses) and one or more items within the array return an error from the API request.
The Failed state can be triggered by any of the following errors:
A connection issue with the integration
The API returned an error message
No response from the API
You can view more details about an error in the Error tab.
Return Data can be passed down directly to a subsequent command or used to create conditional tasks in playbooks.
If the Return Data is Partially Successful or Failed, an Error tab will appear in the Test Result window.
The errortab contains the details responded from D3 SOAR or third-party API calls, including Failure Indicator, Status Code, and Message. This can help you locate the root cause of a command failure.
Parts in Error
Description
Example
Failure Indicator
Indicates the command failure that happened at a specific input and/or API call.
Get Insight Entities failed.
Status Code
The response code issued by the third-party API server or the D3 SOAR system that can be used to locate the corresponding error category. For example, if the returned status code is 401, the selected connection is unauthorized to run the command. The user or system support would need to check the permission setting in the Sumo Logic Cloud SIEM Enterprise (Sumo Logic CSE) portal. Refer to the HTTP Status Code Registry for details.
Status Code: 404.
Message
The raw data or captured key error message from the integration API server about the API request failure.
Message: Insight with the following ID(s) were not found.
Error Sample Data
Get Insight Entities failed.
Status Code: 404.
Message: Insight with the following ID(s) were not found.
Get Insight History
Retrieves the history of Insights using the given Insight IDs.
READER NOTE
Insight IDs is a required parameter to run this command.
Run the Fetch Event command to obtain the Insight IDs. Insight IDs can be found in the raw data at the path $.data.objects[*].id.
Input
Input Parameter
Required/Optional
Description
Example
Insight IDs
Required
The IDs of the Insights for which to retrieve the history. Insight IDs can be obtained using the Fetch Event command.
JSON
[ "*****" ]
Output
Return Data
Indicates one of the possible command execution states: Successful, Partially Successful, or Failed.
The Partially Successful state only occurs when a command’s input accepts an array of items (e.g. an array of IP addresses) and one or more items within the array return an error from the API request.
The Failed state can be triggered by any of the following errors:
A connection issue with the integration
The API returned an error message
No response from the API
You can view more details about an error in the Error tab.
Return Data can be passed down directly to a subsequent command or used to create conditional tasks in playbooks.
SAMPLE DATA
CODE
Successful
Raw Data
The primary response data from the API request.
SAMPLE DATA
JSON
[
{
"insightId": "*****",
"data": {
"history": [
{
"description": "Status set to Closed (False Positive)",
"timestamp": "2023-01-04T23:23:43.920478",
"user": {
"username": "*****@*****.*****"
}
},
{
"description": "Assigned to *****@*****.*****",
"timestamp": "2023-01-05T00:21:32.483909",
"user": {
"username": "*****@*****.*****"
}
},
{
"description": "Resolution set to No Action",
"timestamp": "2023-01-05T00:44:42.609566",
"user": {
"username": "*****@*****.*****"
}
}
]
},
"errors": []
}
]
Result
Provides a brief summary of outputs in an HTML formatted table.
SAMPLE DATA
insightId
*****
data
{'history': [{'description': 'Status set to Closed (False Positive)', 'timestamp': '2023-01-04T23:23:43.920478', 'user': {'username': '*****@*****.*****'}}, {'description': 'Assigned to *****@*****.*****', 'timestamp': '2023-01-05T00:21:32.483909', 'user': {'username': '*****@*****.*****'}}, {'description': 'Resolution set to No Action', 'timestamp': '2023-01-05T00:44:42.609566', 'user': {'username': '*****@*****.*****'}}]}
errors
[]
Error Handling
If the Return Data is Partially Successful or Failed, an Error tab will appear in the Test Result window.
The errortab contains the details responded from D3 SOAR or third-party API calls, including Failure Indicator, Status Code, and Message. This can help you locate the root cause of a command failure.
Parts in Error
Description
Example
Failure Indicator
Indicates the command failure that happened at a specific input and/or API call.
Get Insight History failed.
Status Code
The response code issued by the third-party API server or the D3 SOAR system that can be used to locate the corresponding error category. For example, if the returned status code is 401, the selected connection is unauthorized to run the command. The user or system support would need to check the permission setting in the Sumo Logic Cloud SIEM Enterprise (Sumo Logic CSE) portal. Refer to the HTTP Status Code Registry for details.
Status Code: 404.
Message
The raw data or captured key error message from the integration API server about the API request failure.
Message: Insight with the following ID(s) were not found.
Error Sample Data
Get Insight History failed.
Status Code: 404.
Message: Insight with the following ID(s) were not found.
Get Match List Items
Retrieves Match List Items using the given Match List Item IDs.
READER NOTE
Match List Item IDs is a required parameter to run this command.
Run the List Match List Items command to obtain the Match List Item IDs. Match List Item IDs can be found in the raw data at the path $.data.objects[*].id.
Input
Input Parameter
Required/Optional
Description
Example
Match List Item IDs
Required
The IDs of the Match List Items to retrieve. Match List Item IDs can be obtained using the List Match List Items command.
JSON
[
"*****",
"*****"
]
Output
Return Data
Indicates one of the possible command execution states: Successful, Partially Successful, or Failed.
The Partially Successful state only occurs when a command’s input accepts an array of items (e.g. an array of IP addresses) and one or more items within the array return an error from the API request.
The Failed state can be triggered by any of the following errors:
A connection issue with the integration
The API returned an error message
No response from the API
You can view more details about an error in the Error tab.
Return Data can be passed down directly to a subsequent command or used to create conditional tasks in playbooks.
If the Return Data is Partially Successful or Failed, an Error tab will appear in the Test Result window.
The errortab contains the details responded from D3 SOAR or third-party API calls, including Failure Indicator, Status Code, and Message. This can help you locate the root cause of a command failure.
Parts in Error
Description
Example
Failure Indicator
Indicates the command failure that happened at a specific input and/or API call.
Get Match List Items failed.
Status Code
The response code issued by the third-party API server or the D3 SOAR system that can be used to locate the corresponding error category. For example, if the returned status code is 401, the selected connection is unauthorized to run the command. The user or system support would need to check the permission setting in the Sumo Logic Cloud SIEM Enterprise (Sumo Logic CSE) portal. Refer to the HTTP Status Code Registry for details.
Status Code: 404.
Message
The raw data or captured key error message from the integration API server about the API request failure.
Message: Match List Item with the following ID(s) were not found.
Error Sample Data
Get Match List Items failed.
Status Code: 404.
Message: Match List Item with the following ID(s) were not found.
Get Match Lists
Retrieves Match Lists using the given Match List IDs.
READER NOTE
Match List IDs is a required parameter to run this command.
Run the List Match Lists command to obtain the Match List IDs. Match List IDs can be found in the raw data at the path $.data.objects[*].id.
Input
Input Parameter
Required/Optional
Description
Example
Match List IDs
Required
The IDs of the Match Lists to retrieve. Match List IDs can be obtained using the List Match Lists command.
JSON
[
"*****",
"*****"
]
Output
Return Data
Indicates one of the possible command execution states: Successful, Partially Successful, or Failed.
The Partially Successful state only occurs when a command’s input accepts an array of items (e.g. an array of IP addresses) and one or more items within the array return an error from the API request.
The Failed state can be triggered by any of the following errors:
A connection issue with the integration
The API returned an error message
No response from the API
You can view more details about an error in the Error tab.
Return Data can be passed down directly to a subsequent command or used to create conditional tasks in playbooks.
{'created': '2023-01-04T19:12:31.259588+00:00', 'createdBy': '*****@*****.*****', 'defaultTtl': 14400, 'description': 'Test match list 0104', 'id': '*****', 'lastUpdated': '2023-01-04T19:50:27.385569+00:00', 'lastUpdatedBy': '*****@*****.*****', 'name': 'Match List 2', 'targetColumn': 'SrcIp'}
[]
Error Handling
If the Return Data is Partially Successful or Failed, an Error tab will appear in the Test Result window.
The errortab contains the details responded from D3 SOAR or third-party API calls, including Failure Indicator, Status Code, and Message. This can help you locate the root cause of a command failure.
Parts in Error
Description
Example
Failure Indicator
Indicates the command failure that happened at a specific input and/or API call.
Get Match Lists failed.
Status Code
The response code issued by the third-party API server or the D3 SOAR system that can be used to locate the corresponding error category. For example, if the returned status code is 401, the selected connection is unauthorized to run the command. The user or system support would need to check the permission setting in the Sumo Logic Cloud SIEM Enterprise (Sumo Logic CSE) portal. Refer to the HTTP Status Code Registry for details.
Status Code: 404.
Message
The raw data or captured key error message from the integration API server about the API request failure.
Message: Match List with the following ID(s) were not found.
Error Sample Data
Get Match Lists failed.
Status Code: 404.
Message: Match List with the following ID(s) were not found.
Get Signal Enrichments
Retrieves enrichments of Signals using the given Signal IDs.
READER NOTE
Signal IDs is a required parameter to run this command.
Run the List Signals command to obtain the Signal IDs. Signal IDs can be found in the raw data at the path $.data.objects[*].id.
Input
Input Parameter
Required/Optional
Description
Example
Signal IDs
Required
The IDs of the Signals for which to retrieve enrichments. Signal IDs can be obtained using the List Signals command.
JSON
[ "*****" ]
Output
Return Data
Indicates one of the possible command execution states: Successful, Partially Successful, or Failed.
The Partially Successful state only occurs when a command’s input accepts an array of items (e.g. an array of IP addresses) and one or more items within the array return an error from the API request.
The Failed state can be triggered by any of the following errors:
A connection issue with the integration
The API returned an error message
No response from the API
You can view more details about an error in the Error tab.
Return Data can be passed down directly to a subsequent command or used to create conditional tasks in playbooks.
If the Return Data is Partially Successful or Failed, an Error tab will appear in the Test Result window.
The errortab contains the details responded from D3 SOAR or third-party API calls, including Failure Indicator, Status Code, and Message. This can help you locate the root cause of a command failure.
Parts in Error
Description
Example
Failure Indicator
Indicates the command failure that happened at a specific input and/or API call.
Get Signal Enrichments failed.
Status Code
The response code issued by the third-party API server or the D3 SOAR system that can be used to locate the corresponding error category. For example, if the returned status code is 401, the selected connection is unauthorized to run the command. The user or system support would need to check the permission setting in the Sumo Logic Cloud SIEM Enterprise (Sumo Logic CSE) portal. Refer to the HTTP Status Code Registry for details.
Status Code: 404.
Message
The raw data or captured key error message from the integration API server about the API request failure.
Message: Signal with ID=xxx could not be found.
Error Sample Data
Get Signal Enrichments failed.
Status Code: 404.
Message: Signal with ID=xxx could not be found.
Get Suppress List Items
Retrieves Suppress List Items using the given Suppress List Item IDs.
READER NOTE
Suppress List Item IDs is a required parameter to run this command.
Run the List Suppress List Items command to obtain the Suppress List Item IDs. Suppress List Item IDs can be found in the raw data at the path $.data.objects[*].id.
Input
Input Parameter
Required/Optional
Description
Example
Suppress List Item IDs
Required
The IDs of the Suppress List Items to retrieve. Suppress List Item IDs can be obtained using the List Suppress List Item command.
JSON
[ "*****" ]
Output
Return Data
Indicates one of the possible command execution states: Successful, Partially Successful, or Failed.
The Partially Successful state only occurs when a command’s input accepts an array of items (e.g. an array of IP addresses) and one or more items within the array return an error from the API request.
The Failed state can be triggered by any of the following errors:
A connection issue with the integration
The API returned an error message
No response from the API
You can view more details about an error in the Error tab.
Return Data can be passed down directly to a subsequent command or used to create conditional tasks in playbooks.
If the Return Data is Partially Successful or Failed, an Error tab will appear in the Test Result window.
The errortab contains the details responded from D3 SOAR or third-party API calls, including Failure Indicator, Status Code, and Message. This can help you locate the root cause of a command failure.
Parts in Error
Description
Example
Failure Indicator
Indicates the command failure that happened at a specific input and/or API call.
Get Suppress List Items failed.
Status Code
The response code issued by the third-party API server or the D3 SOAR system that can be used to locate the corresponding error category. For example, if the returned status code is 401, the selected connection is unauthorized to run the command. The user or system support would need to check the permission setting in the Sumo Logic Cloud SIEM Enterprise (Sumo Logic CSE) portal. Refer to the HTTP Status Code Registry for details.
Status Code: 404.
Message
The raw data or captured key error message from the integration API server about the API request failure.
Message: A Suppress List Item with id=xxx could not be found.
Error Sample Data
Get Suppress List Items failed.
Status Code: 404.
Message: A Suppress List Item with id=xxx could not be found.
Get Suppress Lists
Retrieves Suppress Lists using the given Suppress List IDs.
READER NOTE
Suppress List IDs is a required parameter to run this command.
Run the List Suppress Lists command to obtain the Suppress List IDs. Suppress List IDs can be found in the raw data at the path $.data.objects[*].id.
Input
Input Parameter
Required/Optional
Description
Example
Suppress List IDs
Required
The IDs of the Suppress Lists to retrieve. Suppress List IDs can be obtained using the List Suppress Lists command.
JSON
[
"*****",
"*****"
]
Output
Return Data
Indicates one of the possible command execution states: Successful, Partially Successful, or Failed.
The Partially Successful state only occurs when a command’s input accepts an array of items (e.g. an array of IP addresses) and one or more items within the array return an error from the API request.
The Failed state can be triggered by any of the following errors:
A connection issue with the integration
The API returned an error message
No response from the API
You can view more details about an error in the Error tab.
Return Data can be passed down directly to a subsequent command or used to create conditional tasks in playbooks.
If the Return Data is Partially Successful or Failed, an Error tab will appear in the Test Result window.
The errortab contains the details responded from D3 SOAR or third-party API calls, including Failure Indicator, Status Code, and Message. This can help you locate the root cause of a command failure.
Parts in Error
Description
Example
Failure Indicator
Indicates the command failure that happened at a specific input and/or API call.
Get Suppress Lists failed.
Status Code
The response code issued by the third-party API server or the D3 SOAR system that can be used to locate the corresponding error category. For example, if the returned status code is 401, the selected connection is unauthorized to run the command. The user or system support would need to check the permission setting in the Sumo Logic Cloud SIEM Enterprise (Sumo Logic CSE) portal. Refer to the HTTP Status Code Registry for details.
Status Code: 404.
Message
The raw data or captured key error message from the integration API server about the API request failure.
Message: A Suppress List with id=xx could not be found.
Error Sample Data
Get Suppress Lists failed.
Status Code: 404.
Message: A Suppress List with id=xx could not be found.
List Custom Match List Columns
Lists all Custom Match List Columns.
Input
N/A
Output
Return Data
Indicates one of the possible command execution states: Successful or Failed.
The Failed state can be triggered by any of the following errors:
A connection issue with the integration
The API returned an error message
No response from the API
You can view more details about an error in the Error tab.
Return Data can be passed down directly to a subsequent command or used to create conditional tasks in playbooks.
SAMPLE DATA
CODE
Successful
Raw Data
The primary response data from the API request.
SAMPLE DATA
JSON
{
"data": [
{
"fields": [
"action",
"accountId"
],
"id": "*****",
"name": "Custom Match List Column Test"
},
{
"fields": [
"authProvider",
"baseImage",
"action"
],
"id": "*****",
"name": "Custom Match List Column 1"
}
],
"errors": []
}
Key Fields
Common cyber security indicators such as unique IDs, file hash values, CVE numbers, and IP addresses will be extracted from Raw Data as Key Fields.
The system stores these key fields in the path $.[playbookTask].outputData. You can use these key-value pairs as data points for playbook task inputs.
SAMPLE DATA
JSON
{
"CustomMatchListColumnIDs": [
"*****",
"*****"
],
"CustomMatchListColumnNames": [
"Custom Match List Column Test",
"Custom Match List Column 1"
]
}
Result
Provides a brief summary of outputs in an HTML formatted table.
SAMPLE DATA
data
{'fields': ['action', 'accountId'], 'id': '*****', 'name': 'Custom Match List Column Test'}
{'fields': ['authProvider', 'baseImage', 'action'], 'id': '*****', 'name': 'Custom Match List Column 1'}
errors
[]
Error Handling
If the Return Data is Failed, an Error tab will appear in the Test Result window.
The errortab contains the details responded from D3 SOAR or third-party API calls, including Failure Indicator, Status Code, and Message. This can help you locate the root cause of a command failure.
Parts in Error
Description
Example
Failure Indicator
Indicates the command failure that happened at a specific input and/or API call.
List Custom Match List Columns failed.
Status Code
The response code issued by the third-party API server or the D3 SOAR system that can be used to locate the corresponding error category. For example, if the returned status code is 401, the selected connection is unauthorized to run the command. The user or system support would need to check the permission setting in the Sumo Logic Cloud SIEM Enterprise (Sumo Logic CSE) portal. Refer to the HTTP Status Code Registry for details.
Status Code: 401.
Message
The raw data or captured key error message from the integration API server about the API request failure.
Message: User could not be found.
Error Sample Data
List Custom Match List Columns failed.
Status Code: 401.
Message: User could not be found.
List Match List Items
Lists Match List Items using the given Match List Item IDs.
READER NOTE
Match List IDs is an optional parameter to run this command.
Run the List Match Lists command to obtain the Match List IDs. Match List IDs can be found in the raw data at the path $.data.objects[*].id.
Input
Input Parameter
Required/Optional
Description
Example
Limit
Optional
The maximum number of Match List Items to return. By default, all Match List Items matching the defined query will be returned.
50
Value
Optional
The Match List Item value to search for.
desktop-hellod3
Match List IDs
Optional
The IDs of the Match Lists to retrieve items. Match List IDs can be obtained using the List Match Lists command.
Indicates one of the possible command execution states: Successful, Partially Successful, or Failed.
The Partially Successful state only occurs when a command’s input accepts an array of items (e.g. an array of IP addresses) and one or more items within the array return an error from the API request.
The Failed state can be triggered by any of the following errors:
A connection issue with the integration
The API returned an error message
No response from the API
You can view more details about an error in the Error tab.
Return Data can be passed down directly to a subsequent command or used to create conditional tasks in playbooks.
If the Return Data is Partially Successful or Failed, an Error tab will appear in the Test Result window.
The errortab contains the details responded from D3 SOAR or third-party API calls, including Failure Indicator, Status Code, and Message. This can help you locate the root cause of a command failure.
Parts in Error
Description
Example
Failure Indicator
Indicates the command failure that happened at a specific input and/or API call.
List Match List Items failed.
Status Code
The response code issued by the third-party API server or the D3 SOAR system that can be used to locate the corresponding error category. For example, if the returned status code is 401, the selected connection is unauthorized to run the command. The user or system support would need to check the permission setting in the Sumo Logic Cloud SIEM Enterprise (Sumo Logic CSE) portal. Refer to the HTTP Status Code Registry for details.
Status Code: 404.
Message
The raw data or captured key error message from the integration API server about the API request failure.
Message: Match List with ID=xxx could not be found.
Error Sample Data
List Match List Items failed.
Status Code: 404.
Message: Match List with ID=xxx could not be found.
List Match Lists
Lists Match Lists.
Input
Input Parameter
Required/Optional
Description
Example
Limit
Optional
The maximum number of Match Lists to return. By default, all Match Lists in the system will be returned.
50
Sort Field
Optional
The field used to sort Match Lists. Some available sort fields are created, description, id, name, and lastUpdated. By default, the field used for sorting is the name of Match Lists.
name
Sort Direction
Optional
The sort direction for the returned Match Lists. Available options are:
Ascending
Descending
By default, the value is Ascending.
Ascending
Output
Return Data
Indicates one of the possible command execution states: Successful or Failed
The Failed state can be triggered by any of the following errors:
A connection issue with the integration
The API returned an error message
No response from the API
You can view more details about an error in the Error tab.
Return Data can be passed down directly to a subsequent command or used to create conditional tasks in playbooks.
If the Return Data is Failed, an Error tab will appear in the Test Result window.
The errortab contains the details responded from D3 SOAR or third-party API calls, including Failure Indicator, Status Code, and Message. This can help you locate the root cause of a command failure.
Parts in Error
Description
Example
Failure Indicator
Indicates the command failure that happened at a specific input and/or API call.
List Match Lists failed.
Status Code
The response code issued by the third-party API server or the D3 SOAR system that can be used to locate the corresponding error category. For example, if the returned status code is 401, the selected connection is unauthorized to run the command. The user or system support would need to check the permission setting in the Sumo Logic Cloud SIEM Enterprise (Sumo Logic CSE) portal. Refer to the HTTP Status Code Registry for details.
Status Code: 401.
Message
The raw data or captured key error message from the integration API server about the API request failure.
Message: User could not be found.
Error Sample Data
List Match Lists failed.
Status Code: 401.
Message: User could not be found.
List Rules
Lists all rules matching the given query.
READER NOTE
For the syntax of the Query parameter, refer to the Sumo Logic CSE API reference. A screenshot of the reference is provided below for your convenience.
Input
Input Parameter
Required/Optional
Description
Example
Query
Optional
The query string used to filter the returned rules. For example, to search for rules with a specific name, the query string name:contains("{{ruleName}}") can be used. Refer to Get the list of Rules for a given query | Sumo Logic CSE for more information about the query syntax. By default, all rules regardless of the query will be returned.
Common cyber security indicators such as unique IDs, file hash values, CVE numbers, and IP addresses will be extracted from Raw Data as Key Fields.
The system stores these key fields in the path $.[playbookTask].outputData. You can use these key-value pairs as data points for playbook task inputs.
SAMPLE DATA
JSON
{
"RuleIDs": [
"MATCH-*****"
],
"RuleNames": [
"AWS CloudTrail - IAM CreateUser Action Observed"
],
"DescriptionExpressions": [
"This signal fires for all observances of the CreateUser action in the IAM event source. Creating AWS users is likely a benign, infrequent activity. Hostile actors will create users to persist access. Use this signal in context of other activity to determine intent."
]
}
Result
Provides a brief summary of outputs in an HTML formatted table.
SAMPLE DATA
data
{'hasNextPage': True, 'objects': [{'assetField': 'device_ip', 'category': 'Persistence', 'contentType': 'RULE', 'created': '2023-01-03T22:03:47.169919+00:00', 'createdBy': '', 'deleted': False, 'descriptionExpression': 'This signal fires for all observances of the CreateUser action in the IAM event source. Creating AWS users is likely a benign, infrequent activity. Hostile actors will create users to persist access. Use this signal in context of other activity to determine intent.', 'descriptionExpressionOverride': None, 'enabled': True, 'entitySelectors': [{'entityType': '_hostname', 'expression': 'device_hostname'}, {'entityType': '_ip', 'expression': 'device_ip'}, {'entityType': '_username', 'expression': 'user_username'}, {'entityType': '_ip', 'expression': 'srcDevice_ip'}], 'entitySelectorsOverride': {'original': [{'entityType': '_hostname', 'expression': 'device_hostname'}, {'entityType': '_ip', 'expression': 'device_ip'}, {'entityType': '_username', 'expression': 'user_username'}, {'entityType': '_ip', 'expression': 'srcDevice_ip'}], 'override': []}, 'expression': "metadata_vendor = 'Amazon AWS'\nAND metadata_product = 'CloudTrail'\nAND application = 'iam.amazonaws.com'\nAND action = 'CreateUser'", 'hasOverride': False, 'id': 'MATCH-*****', 'isPrototype': False, 'isPrototypeOverride': None, 'lastUpdated': '2023-01-03T22:03:47.169930+00:00', 'lastUpdatedBy': '', 'name': 'AWS CloudTrail - IAM CreateUser Action Observed', 'nameExpression': 'AWS CloudTrail - IAM CreateUser Action Observed', 'nameExpressionOverride': None, 'nameOverride': None, 'parentJaskId': None, 'ruleId': *****, 'ruleSource': 'sumo', 'ruleType': 'templated match', 'scoreMapping': {'default': 2, 'field': None, 'mapping': None, 'type': 'constant'}, 'scoreMappingOverride': None, 'signalCount07d': 0, 'signalCount24h': 0, 'status': {'message': None, 'status': 'ACTIVE'}, 'stream': 'record', 'summaryExpression': 'User {{changeTarget}} created by user: {{user_username}}', 'summaryExpressionOverride': None, 'tags': ['_mitreAttackTactic:TA0003', '_mitreAttackTechnique:T1136', '_mitreAttackTechnique:T1136.003'], 'tagsOverride': {'original': ['_mitreAttackTactic:TA0003', '_mitreAttackTechnique:T1136', '_mitreAttackTechnique:T1136.003'], 'override': []}, 'tuningExpressions': []}], 'total': 130}
errors
[]
Error Handling
If the Return Data is Failed, an Error tab will appear in the Test Result window.
The errortab contains the details responded from D3 SOAR or third-party API calls, including Failure Indicator, Status Code, and Message. This can help you locate the root cause of a command failure.
Parts in Error
Description
Example
Failure Indicator
Indicates the command failure that happened at a specific input and/or API call.
List Rules failed.
Status Code
The response code issued by the third-party API server or the D3 SOAR system that can be used to locate the corresponding error category. For example, if the returned status code is 401, the selected connection is unauthorized to run the command. The user or system support would need to check the permission setting in the Sumo Logic Cloud SIEM Enterprise (Sumo Logic CSE) portal. Refer to the HTTP Status Code Registry for details.
Status Code: 500.
Message
The raw data or captured key error message from the integration API server about the API request failure.
Message: Internal server error.
Error Sample Data
List Rules failed.
Status Code: 500.
Message: Internal server error.
List Rule Tuning Expressions
Lists Rule Tuning Expressions.
Input
Input Parameter
Required/Optional
Description
Example
Limit
Optional
The maximum number of Rule Tuning Expressions to return. By default, all Rule Tuning Expressions in the system will be returned.
10
Sort Field
Optional
The field used to sort Rule Tuning Expressions. Available options are:
Created
Enabled
Name
Related Rule
Updated
By default, the field used for sorting is Name.
Name
Sort Direction
Optional
The sort direction to sort the Rule Tuning Expressions. Available options are:
Ascending
Descending
By default, the value is Ascending.
Ascending
Output
Return Data
Indicates one of the possible command execution states: Successful or Failed.
The Failed state can be triggered by any of the following errors:
A connection issue with the integration
The API returned an error message
No response from the API
You can view more details about an error in the Error tab.
Return Data can be passed down directly to a subsequent command or used to create conditional tasks in playbooks.
If the Return Data is Failed, an Error tab will appear in the Test Result window.
The errortab contains the details responded from D3 SOAR or third-party API calls, including Failure Indicator, Status Code, and Message. This can help you locate the root cause of a command failure.
Parts in Error
Description
Example
Failure Indicator
Indicates the command failure that happened at a specific input and/or API call.
List Rule Tuning Expressions failed.
Status Code
The response code issued by the third-party API server or the D3 SOAR system that can be used to locate the corresponding error category. For example, if the returned status code is 401, the selected connection is unauthorized to run the command. The user or system support would need to check the permission setting in the Sumo Logic Cloud SIEM Enterprise (Sumo Logic CSE) portal. Refer to the HTTP Status Code Registry for details.
Status Code: 401.
Message
The raw data or captured key error message from the integration API server about the API request failure.
Message: User could not be found.
Error Sample Data
List Rule Tuning Expressions failed.
Status Code: 401.
Message: User could not be found.
List Signals
Lists Signals.
READER NOTE
Signal IDs is an optional parameterto run this command.
If the Signal IDs have not been obtained, run this command with an empty Signal IDs parameter to obtain them.
For the syntax of the Query parameter, refer to the Sumo Logic CSE API reference. A screenshot of the reference is provided below.
Input
Input Parameter
Required/Optional
Description
Example
Signal IDs
Optional
The IDs of the Signals for which to retrieve. If the Signal IDs have not been obtained, run the command with this parameter empty to obtain them.
JSON
[ "*****" ]
Query
Optional
The query string used to filter the returned Signals. Refer to Get the list of all Signals | Sumo Logic CSE. If the Signal IDs parameter is specified, this parameter will be ignored. If neither input parameters are specified, all Signals will be returned.
severity:>=6 timestamp:>=2023-01-04T02:00:00
Output
Return Data
Indicates one of the possible command execution states: Successful, Partially Successful, or Failed.
The Partially Successful state only occurs when a command’s input accepts an array of items (e.g. an array of IP addresses) and one or more items within the array return an error from the API request.
The Failed state can be triggered by any of the following errors:
A connection issue with the integration
The API returned an error message
No response from the API
You can view more details about an error in the Error tab.
Return Data can be passed down directly to a subsequent command or used to create conditional tasks in playbooks.
SAMPLE DATA
CODE
Successful
Raw Data
The primary response data from the API request.
SAMPLE DATA
JSON
{
"data": {
"nextPageToken": null,
"objects": [
{
"allRecords": [
{
"bro_dns_answers": [],
"bro_file_bytes": {},
"bro_file_connUids": [],
"bro_flow_service": [],
"bro_ftp_pendingCommands": [],
"bro_http_cookieVars": [],
"bro_http_origFuids": [],
"bro_http_origMimeTypes": [],
"bro_http_request_headers": {},
"bro_http_request_proxied": [],
"bro_http_response_headers": {},
"bro_http_response_respFuids": [],
"bro_http_response_respMimeTypes": [],
"bro_http_tags": [],
"bro_http_uriVars": [],
"bro_kerberos_clientCert": {},
"bro_kerberos_serverCert": {},
"bro_sip_headers": {},
"bro_sip_requestPath": [],
"bro_sip_responsePath": [],
"bro_ssl_certChainFuids": [],
"bro_ssl_clientCertChainFuids": [],
"cseSignal": {},
"day": 4,
"description": "A process using Force Data Execution Prevention (Force DEP) tried to execute non-executable memory. The process was blocked.",
"device_hostname": "*****",
"device_hostname_raw": "*****",
"device_ip": "***.***.***.***",
"device_ip_ipv4IntValue": *****,
"device_ip_isInternal": true,
"device_ip_version": 4,
"fieldTags": {},
"fields": {
"event.CommandLine": "*****",
"event.ComputerName": "*****",
"event.DetectDescription": "A process using Force Data Execution Prevention (Force DEP) tried to execute non-executable memory. The process was blocked.",
"event.DetectId": "*****",
"event.DetectName": "Blocked Exploit",
"event.FalconHostLink": "https://*****.*****",
"event.FileName": "dllhost.exe",
"event.FilePath": "\\Device\\HarddiskVolume4\\Windows\\SysWOW64",
"event.GrandparentCommandLine": "C:\\WINDOWS\\system32\\services.exe",
"event.GrandparentImageFileName": "\\Device\\HarddiskVolume4\\Windows\\System32\\services.exe",
"event.LocalIP": "***.***.***.***",
"event.MACAddress": "***-***-***-***-***-***",
"event.MD5String": "*****",
"event.MachineDomain": "*****",
"event.Objective": "Falcon Detection Method",
"event.ParentCommandLine": "C:\\WINDOWS\\system32\\svchost.exe -k DcomLaunch -p",
"event.ParentImageFileName": "\\Device\\HarddiskVolume4\\Windows\\System32\\svchost.exe",
"event.ParentProcessId": "*****",
"event.PatternDispositionDescription": "Prevention, operation blocked.",
"event.PatternDispositionFlags.BlockingUnsupportedOrDisabled": "false",
"event.PatternDispositionFlags.BootupSafeguardEnabled": "false",
"event.PatternDispositionFlags.CriticalProcessDisabled": "false",
"event.PatternDispositionFlags.Detect": "false",
"event.PatternDispositionFlags.FsOperationBlocked": "false",
"event.PatternDispositionFlags.HandleOperationDowngraded": "false",
"event.PatternDispositionFlags.InddetMask": "false",
"event.PatternDispositionFlags.Indicator": "false",
"event.PatternDispositionFlags.KillActionFailed": "false",
"event.PatternDispositionFlags.KillParent": "false",
"event.PatternDispositionFlags.KillProcess": "false",
"event.PatternDispositionFlags.KillSubProcess": "false",
"event.PatternDispositionFlags.OperationBlocked": "true",
"event.PatternDispositionFlags.PolicyDisabled": "false",
"event.PatternDispositionFlags.ProcessBlocked": "false",
"event.PatternDispositionFlags.QuarantineFile": "false",
"event.PatternDispositionFlags.QuarantineMachine": "false",
"event.PatternDispositionFlags.RegistryOperationBlocked": "false",
"event.PatternDispositionFlags.Rooting": "false",
"event.PatternDispositionFlags.SensorOnly": "false",
"event.PatternDispositionFlags.SuspendParent": "false",
"event.PatternDispositionFlags.SuspendProcess": "false",
"event.PatternDispositionValue": "1024",
"event.ProcessEndTime": "1672865973",
"event.ProcessId": "*****",
"event.ProcessStartTime": "1672865965",
"event.SHA1String": "*****",
"event.SHA256String": "*****",
"event.SensorId": "*****",
"event.Severity": "4",
"event.SeverityName": "High",
"event.Tactic": "Exploit",
"event.Technique": "Exploit Mitigation",
"event.UserName": "sysint",
"metadata.customerIDString": "*****",
"metadata.eventCreationTime": "1672865965000",
"metadata.eventType": "DetectionSummaryEvent",
"metadata.offset": "2178627",
"metadata.version": "1.0"
},
"file_basename": "dllhost.exe",
"file_hash_md5": "*****",
"file_hash_sha256": "*****",
"file_path": "\\Device\\HarddiskVolume4\\Windows\\SysWOW64",
"friendlyName": "record",
"hour": 20,
"http_requestHeaders": {},
"listMatches": [],
"matchedItems": [],
"metadata_deviceEventId": "*****",
"metadata_mapperName": "CrowdStrike Falcon Host API DetectionSummaryEvent (CNC)",
"metadata_mapperUid": "*****",
"metadata_orgId": "*****",
"metadata_parseTime": 1672866226154,
"metadata_product": "Falcon",
"metadata_productGuid": "*****",
"metadata_receiptTime": 1672866186,
"metadata_schemaVersion": 3,
"metadata_sensorId": "*****",
"metadata_sensorInformation": {},
"metadata_sensorZone": "default",
"metadata_sourceCategory": "HTTP Collection",
"metadata_sourceMessageId": "*****",
"metadata_vendor": "CrowdStrike",
"month": 1,
"normalizedSeverity": 6,
"objectType": "Endpoint",
"severity": "4",
"threat_name": "Blocked Exploit",
"threat_referenceUrl": "https://*****.*****",
"threat_ruleType": "direct",
"threat_signalName": "A process using Force Data Execution Prevention (Force DEP) tried to execute non-executable memory. The process was blocked.",
"timestamp": 1672865965000,
"uid": "*****",
"user_username": "sysint",
"user_username_raw": "sysint",
"year": 2023
}
],
"artifacts": [],
"contentType": "RULE",
"description": "Passes through an alert from an endpoint security product and adjusts the severity accordingly based on the severity provided in the log.",
"entity": {
"entityType": "_username",
"hostname": null,
"id": "*****",
"macAddress": null,
"name": "sysint",
"sensorZone": "",
"value": "sysint"
},
"id": "*****",
"name": "CrowdStrike Falcon - A process using Force Data Execution Prevention (Force DEP) tried to execute non-executable memory. The process was blocked.",
"recordCount": 1,
"recordTypes": [],
"ruleId": "MATCH-*****",
"severity": 6,
"stage": "Unknown/Other",
"summary": "Threat: Blocked Exploit detected on host: *****",
"suppressed": false,
"tags": [],
"timestamp": "2023-01-04T20:59:25"
}
]
},
"errors": []
}
Key Fields
Common cyber security indicators such as unique IDs, file hash values, CVE numbers, and IP addresses will be extracted from Raw Data as Key Fields.
The system stores these key fields in the path $.[playbookTask].outputData. You can use these key-value pairs as data points for playbook task inputs.
SAMPLE DATA
JSON
{
"SignalIDs": [
"*****"
],
"SignalNames": [
"CrowdStrike Falcon - A process using Force Data Execution Prevention (Force DEP) tried to execute non-executable memory. The process was blocked."
],
"Descriptions": [
"Passes through an alert from an endpoint security product and adjusts the severity accordingly based on the severity provided in the log."
]
}
Result
Provides a brief summary of outputs in an HTML formatted table.
SAMPLE DATA
data
{'nextPageToken': None, 'objects': [{'allRecords': [{'bro_dns_answers': [], 'bro_file_bytes': {}, 'bro_file_connUids': [], 'bro_flow_service': [], 'bro_ftp_pendingCommands': [], 'bro_http_cookieVars': [], 'bro_http_origFuids': [], 'bro_http_origMimeTypes': [], 'bro_http_request_headers': {}, 'bro_http_request_proxied': [], 'bro_http_response_headers': {}, 'bro_http_response_respFuids': [], 'bro_http_response_respMimeTypes': [], 'bro_http_tags': [], 'bro_http_uriVars': [], 'bro_kerberos_clientCert': {}, 'bro_kerberos_serverCert': {}, 'bro_sip_headers': {}, 'bro_sip_requestPath': [], 'bro_sip_responsePath': [], 'bro_ssl_certChainFuids': [], 'bro_ssl_clientCertChainFuids': [], 'cseSignal': {}, 'day': 4, 'description': 'A process using Force Data Execution Prevention (Force DEP) tried to execute non-executable memory. The process was blocked.', 'device_hostname': '*****', 'device_hostname_raw': '*****', 'device_ip': '***.***.***.***', 'device_ip_ipv4IntValue': *****, 'device_ip_isInternal': True, 'device_ip_version': 4, 'fieldTags': {}, 'fields': {'event.CommandLine': '*****', 'event.ComputerName': '*****', 'event.DetectDescription': 'A process using Force Data Execution Prevention (Force DEP) tried to execute non-executable memory. The process was blocked.', 'event.DetectId': '*****', 'event.DetectName': 'Blocked Exploit', 'event.FalconHostLink': 'https://*****.*****', 'event.FileName': 'dllhost.exe', 'event.FilePath': '\\Device\\HarddiskVolume4\\Windows\\SysWOW64', 'event.GrandparentCommandLine': 'C:\\WINDOWS\\system32\\services.exe', 'event.GrandparentImageFileName': '\\Device\\HarddiskVolume4\\Windows\\System32\\services.exe', 'event.LocalIP': '***.***.***.***', 'event.MACAddress': '***-***-***-***-***-***', 'event.MD5String': '*****', 'event.MachineDomain': '*****', 'event.Objective': 'Falcon Detection Method', 'event.ParentCommandLine': 'C:\\WINDOWS\\system32\\svchost.exe -k DcomLaunch -p', 'event.ParentImageFileName': '\\Device\\HarddiskVolume4\\Windows\\System32\\svchost.exe', 'event.ParentProcessId': '*****', 'event.PatternDispositionDescription': 'Prevention, operation blocked.', 'event.PatternDispositionFlags.BlockingUnsupportedOrDisabled': 'false', 'event.PatternDispositionFlags.BootupSafeguardEnabled': 'false', 'event.PatternDispositionFlags.CriticalProcessDisabled': 'false', 'event.PatternDispositionFlags.Detect': 'false', 'event.PatternDispositionFlags.FsOperationBlocked': 'false', 'event.PatternDispositionFlags.HandleOperationDowngraded': 'false', 'event.PatternDispositionFlags.InddetMask': 'false', 'event.PatternDispositionFlags.Indicator': 'false', 'event.PatternDispositionFlags.KillActionFailed': 'false', 'event.PatternDispositionFlags.KillParent': 'false', 'event.PatternDispositionFlags.KillProcess': 'false', 'event.PatternDispositionFlags.KillSubProcess': 'false', 'event.PatternDispositionFlags.OperationBlocked': 'true', 'event.PatternDispositionFlags.PolicyDisabled': 'false', 'event.PatternDispositionFlags.ProcessBlocked': 'false', 'event.PatternDispositionFlags.QuarantineFile': 'false', 'event.PatternDispositionFlags.QuarantineMachine': 'false', 'event.PatternDispositionFlags.RegistryOperationBlocked': 'false', 'event.PatternDispositionFlags.Rooting': 'false', 'event.PatternDispositionFlags.SensorOnly': 'false', 'event.PatternDispositionFlags.SuspendParent': 'false', 'event.PatternDispositionFlags.SuspendProcess': 'false', 'event.PatternDispositionValue': '1024', 'event.ProcessEndTime': '1672865973', 'event.ProcessId': '*****', 'event.ProcessStartTime': '1672865965', 'event.SHA1String': '*****', 'event.SHA256String': '*****', 'event.SensorId': '*****', 'event.Severity': '4', 'event.SeverityName': 'High', 'event.Tactic': 'Exploit', 'event.Technique': 'Exploit Mitigation', 'event.UserName': 'sysint', 'metadata.customerIDString': '*****', 'metadata.eventCreationTime': '1672865965000', 'metadata.eventType': 'DetectionSummaryEvent', 'metadata.offset': '2178627', 'metadata.version': '1.0'}, 'file_basename': 'dllhost.exe', 'file_hash_md5': '*****', 'file_hash_sha256': '*****', 'file_path': '\\Device\\HarddiskVolume4\\Windows\\SysWOW64', 'friendlyName': 'record', 'hour': 20, 'http_requestHeaders': {}, 'listMatches': [], 'matchedItems': [], 'metadata_deviceEventId': '*****', 'metadata_mapperName': 'CrowdStrike Falcon Host API DetectionSummaryEvent (CNC)', 'metadata_mapperUid': '*****', 'metadata_orgId': '*****', 'metadata_parseTime': 1672866226154, 'metadata_product': 'Falcon', 'metadata_productGuid': '*****', 'metadata_receiptTime': 1672866186, 'metadata_schemaVersion': 3, 'metadata_sensorId': '*****', 'metadata_sensorInformation': {}, 'metadata_sensorZone': 'default', 'metadata_sourceCategory': 'HTTP Collection', 'metadata_sourceMessageId': '*****', 'metadata_vendor': 'CrowdStrike', 'month': 1, 'normalizedSeverity': 6, 'objectType': 'Endpoint', 'severity': '4', 'threat_name': 'Blocked Exploit', 'threat_referenceUrl': 'https://*****.*****', 'threat_ruleType': 'direct', 'threat_signalName': 'A process using Force Data Execution Prevention (Force DEP) tried to execute non-executable memory. The process was blocked.', 'timestamp': 1672865965000, 'uid': '*****', 'user_username': 'sysint', 'user_username_raw': 'sysint', 'year': 2023}], 'artifacts': [], 'contentType': 'RULE', 'description': 'Passes through an alert from an endpoint security product and adjusts the severity accordingly based on the severity provided in the log.', 'entity': {'entityType': '_username', 'hostname': None, 'id': '*****', 'macAddress': None, 'name': 'sysint', 'sensorZone': '', 'value': 'sysint'}, 'id': '*****', 'name': 'CrowdStrike Falcon - A process using Force Data Execution Prevention (Force DEP) tried to execute non-executable memory. The process was blocked.', 'recordCount': 1, 'recordTypes': [], 'ruleId': 'MATCH-*****', 'severity': 6, 'stage': 'Unknown/Other', 'summary': 'Threat: Blocked Exploit detected on host: *****', 'suppressed': False, 'tags': [], 'timestamp': '2023-01-04T20:59:25'}]}
errors
[]
Error Handling
If the Return Data is Partially Successful or Failed, an Error tab will appear in the Test Result window.
The errortab contains the details responded from D3 SOAR or third-party API calls, including Failure Indicator, Status Code, and Message. This can help you locate the root cause of a command failure.
Parts in Error
Description
Example
Failure Indicator
Indicates the command failure that happened at a specific input and/or API call.
List Signals failed.
Status Code
The response code issued by the third-party API server or the D3 SOAR system that can be used to locate the corresponding error category. For example, if the returned status code is 401, the selected connection is unauthorized to run the command. The user or system support would need to check the permission setting in the Sumo Logic Cloud SIEM Enterprise (Sumo Logic CSE) portal. Refer to the HTTP Status Code Registry for details.
Status Code: 404.
Message
The raw data or captured key error message from the integration API server about the API request failure.
Message: Signal with ID=xxx could not be found.
Error Sample Data
List Signals failed.
Status Code: 404.
Message: Signal with ID=xxx could not be found.
List Suppress List Items
Lists Suppress List Items.
READER NOTE
Suppress List IDs is an optional parameter to run this command.
Run the List Suppress Lists command to obtain the Suppress List IDs. Suppress List IDs can be found in the returned raw data at the path $.data.objects[*].id.
For the Query parameter’s syntax, refer to the Sumo Logic CSE API reference. A screenshot of the reference is provided below.
Input
Input Parameter
Required/Optional
Description
Example
Limit
Optional
The maximum number of Suppress List Items to return. By default, all Suppress List Items matching the defined query will be returned.
50
Value
Optional
The Suppress List Item value to search for.
desktop-hellod3
Suppress List IDs
Optional
The IDs of the Suppress Lists to retrieve items. Suppress List IDs can be obtained using the List Suppress Lists command.
If the Return Data is Failed, an Error tab will appear in the Test Result window.
The errortab contains the details responded from D3 SOAR or third-party API calls, including Failure Indicator, Status Code, and Message. This can help you locate the root cause of a command failure.
Parts in Error
Description
Example
Failure Indicator
Indicates the command failure that happened at a specific input and/or API call.
List Suppress List Items failed.
Status Code
The response code issued by the third-party API server or the D3 SOAR system that can be used to locate the corresponding error category. For example, if the returned status code is 401, the selected connection is unauthorized to run the command. The user or system support would need to check the permission setting in the Sumo Logic Cloud SIEM Enterprise (Sumo Logic CSE) portal. Refer to the HTTP Status Code Registry for details.
Status Code: 500.
Message
The raw data or captured key error message from the integration API server about the API request failure.
Message: INTERNAL_SERVER_ERROR.
Error Sample Data
List Suppress List Items failed.
Status Code: 500.
Message: INTERNAL_SERVER_ERROR.
List Suppress Lists
Lists Suppress Lists.
Input
Input Parameter
Required/Optional
Description
Example
Limit
Optional
The maximum number of Suppress Lists to return. By default, all Suppress Lists will be returned.
50
Sort Field
Optional
The field used to sort Suppress Lists. Some available values are: created, createdBy, defaultTtl, description, id, lastUpdated, lastUpdatedBy, name and targetColumn. By default, the field used for sorting is name.
name
Sort Direction
Optional
The sort direction for the Suppression Lists. Available options are:
Ascending
Descending
By default, the value is Ascending.
Ascending
Output
Return Data
Indicates one of the possible command execution states: Successful or Failed.
The Failed state can be triggered by any of the following errors:
A connection issue with the integration
The API returned an error message
No response from the API
You can view more details about an error in the Error tab.
Return Data can be passed down directly to a subsequent command or used to create conditional tasks in playbooks.
If the Return Data is Failed, an Error tab will appear in the Test Result window.
The errortab contains the details responded from D3 SOAR or third-party API calls, including Failure Indicator, Status Code, and Message. This can help you locate the root cause of a command failure.
Parts in Error
Description
Example
Failure Indicator
Indicates the command failure that happened at a specific input and/or API call.
List Suppress Lists failed.
Status Code
The response code issued by the third-party API server or the D3 SOAR system that can be used to locate the corresponding error category. For example, if the returned status code is 401, the selected connection is unauthorized to run the command. The user or system support would need to check the permission setting in the Sumo Logic Cloud SIEM Enterprise (Sumo Logic CSE) portal. Refer to the HTTP Status Code Registry for details.
Status Code: 500.
Message
The raw data or captured key error message from the integration API server about the API request failure.
Message: INTERNAL_SERVER_ERROR.
Error Sample Data
List Suppress Lists failed.
Status Code: 500.
Message: INTERNAL_SERVER_ERROR.
On Dismiss Event
Updates the status of an Insight and adds the hardcoded comment "No Action" after the Insight has been ingested and dismissed as an event in D3 SOAR. This process can be automated if it has been configured with the integration connection. Refer to step 3i in Configuring D3 to Work with Sumo Logic Cloud SIEM Enterprise (Sumo Logic SIEM).
READER NOTE
Raw Data is a required parameter to run this command.
Run the Fetch Event command to obtain the returned Raw Data. Copy the returned raw data to be used as the input for this parameter.
Input
Input Parameter
Required/Optional
Description
Example
Raw Data
Required
The JSON objects of the returned Insights from the Fetch Event command to update the status and add the hardcoded comment.
Indicates one of the possible command execution states: Successful, Partially Successful, or Failed.
The Partially Successful state only occurs when a command’s input accepts an array of items (e.g. an array of IP addresses) and one or more items within the array return an error from the API request.
The Failed state can be triggered by any of the following errors:
A connection issue with the integration
The API returned an error message
No response from the API
You can view more details about an error in the Error tab.
Return Data can be passed down directly to a subsequent command or used to create conditional tasks in playbooks.
If the Return Data is Partially Successful or Failed, an Error tab will appear in the Test Result window.
The errortab contains the details responded from D3 SOAR or third-party API calls, including Failure Indicator, Status Code, and Message. This can help you locate the root cause of a command failure.
Parts in Error
Description
Example
Failure Indicator
Indicates the command failure that happened at a specific input and/or API call.
On Dismiss Event failed.
Status Code
The response code issued by the third-party API server or the D3 SOAR system that can be used to locate the corresponding error category. For example, if the returned status code is 401, the selected connection is unauthorized to run the command. The user or system support would need to check the permission setting in the Sumo Logic Cloud SIEM Enterprise (Sumo Logic CSE) portal. Refer to the HTTP Status Code Registry for details.
Status Code: 400.
Message
The raw data or captured key error message from the integration API server about the API request failure.
Message: The value for parameter (Raw Data) is invalid.
Error Sample Data
On Dismiss Event failed.
Status Code: 400.
Message: You must have a valid Support account to call this API.
Update Custom Match List Column
Updates a Custom Match List column using the given Custom Match List Column ID.
READER NOTE
Custom Match List Column ID is a required parameterto run this command.
Run the List Custom Match List Columns command to obtain the Custom Match List Column ID. Custom Match List Column IDs can be found in the raw data at the path $.data[*].id.
Input
Input Parameter
Required/Optional
Description
Example
Custom Match List Column ID
Required
The ID of the Custom Match List column in which values require updating. Custom Match List Column IDs can be obtained using the List Custom Match List Columns command.
*****
Custom Match List Column Name
Required
The updated name for the specified Custom Match List column.
Custom Match List Column Test
Custom Match List Column Fields
Required
The updated fields of the specified Custom Match List column.
JSON
[
"action",
"accountId",
"application"
]
Output
Return Data
Indicates one of the possible command execution states: Successful or Failed.
The Failed state can be triggered by any of the following errors:
A connection issue with the integration
The API returned an error message
No response from the API
You can view more details about an error in the Error tab.
Return Data can be passed down directly to a subsequent command or used to create conditional tasks in playbooks.
Common cyber security indicators such as unique IDs, file hash values, CVE numbers, and IP addresses will be extracted from Raw Data as Key Fields.
The system stores these key fields in the path $.[playbookTask].outputData. You can use these key-value pairs as data points for playbook task inputs.
SAMPLE DATA
JSON
{
"CustomMatchListColumnID": *****,
"CustomMatchListColumnName": "Custom Match List Column Test",
"CustomMatchListColumnFields": [
"action",
"accountId",
"application"
]
}
Result
Provides a brief summary of outputs in an HTML formatted table.
SAMPLE DATA
fields
action
accountId
application
id
*****
name
Custom Match List Column Test
Error Handling
If the Return Data is Failed, an Error tab will appear in the Test Result window.
The errortab contains the details responded from D3 SOAR or third-party API calls, including Failure Indicator, Status Code, and Message. This can help you locate the root cause of a command failure.
Parts in Error
Description
Example
Failure Indicator
Indicates the command failure that happened at a specific input and/or API call.
Update Custom Match List Column failed.
Status Code
The response code issued by the third-party API server or the D3 SOAR system that can be used to locate the corresponding error category. For example, if the returned status code is 401, the selected connection is unauthorized to run the command. The user or system support would need to check the permission setting in the Sumo Logic Cloud SIEM Enterprise (Sumo Logic CSE) portal. Refer to the HTTP Status Code Registry for details.
Status Code: 404.
Message
The raw data or captured key error message from the integration API server about the API request failure.
Message: Custom Match List Column with id=xx could not be found.
Error Sample Data
Update Custom Match List Column failed.
Status Code: 404.
Message: Custom Match List Column with id=xx could not be found.
Update Insight Assignee
Updates the assignee of the specified Insights.
READER NOTE
Insight IDs is a required parameter to run this command.
Run the Fetch Event command to obtain the Insight IDs. Insight IDs can be found in the raw data at the path $.data.objects[*].id.
Input
Input Parameter
Required/Optional
Description
Example
Insight IDs
Required
The IDs of the Insights for which to update. Insight IDs can be obtained using the Fetch Event command.
JSON
[ "*****" ]
Assignee Type
Required
The assignee type. Available options are:
User
Team
USER
Name
Required
The user name or team name of the assignee. User names and team names can be obtained from the Sumo Logic platform. The user name should be the email address of the user.
*****@*****.*****
Output
Return Data
Indicates one of the possible command execution states: Successful, Partially Successful, or Failed.
The Partially Successful state only occurs when a command’s input accepts an array of items (e.g. an array of IP addresses) and one or more items within the array return an error from the API request.
The Failed state can be triggered by any of the following errors:
A connection issue with the integration
The API returned an error message
No response from the API
You can view more details about an error in the Error tab.
Return Data can be passed down directly to a subsequent command or used to create conditional tasks in playbooks.
If the Return Data is Partially Successful or Failed, an Error tab will appear in the Test Result window.
The errortab contains the details responded from D3 SOAR or third-party API calls, including Failure Indicator, Status Code, and Message. This can help you locate the root cause of a command failure.
Parts in Error
Description
Example
Failure Indicator
Indicates the command failure that happened at a specific input and/or API call.
Update Insight Assignee failed.
Status Code
The response code issued by the third-party API server or the D3 SOAR system that can be used to locate the corresponding error category. For example, if the returned status code is 401, the selected connection is unauthorized to run the command. The user or system support would need to check the permission setting in the Sumo Logic Cloud SIEM Enterprise (Sumo Logic CSE) portal. Refer to the HTTP Status Code Registry for details.
Status Code: 404.
Message
The raw data or captured key error message from the integration API server about the API request failure.
Message: Insight with ID=xxx not found.
Error Sample Data
Update Insight Assignee failed.
Status Code: 404.
Message: Insight with ID=xxx not found.
Update Insight Enrichment
Creates or updates an Enrichment for the specified Insights.
READER NOTE
Insight IDs is a required parameterto run this command.
Run the Fetch Event command to obtain the Insight IDs. Insight IDs can be found in the raw data at the path $.data.objects[*].id.
Input
Input Parameter
Required/Optional
Description
Example
Insight IDs
Required
The IDs of the Insights for which to create or update an enrichment. Insight IDs can be obtained using the Fetch Event command.
Indicates one of the possible command execution states: Successful, Partially Successful, or Failed.
The Partially Successful state only occurs when a command’s input accepts an array of items (e.g. an array of IP addresses) and one or more items within the array return an error from the API request.
The Failed state can be triggered by any of the following errors:
A connection issue with the integration
The API returned an error message
No response from the API
You can view more details about an error in the Error tab.
Return Data can be passed down directly to a subsequent command or used to create conditional tasks in playbooks.
If the Return Data is Partially Successful or Failed, an Error tab will appear in the Test Result window.
The errortab contains the details responded from D3 SOAR or third-party API calls, including Failure Indicator, Status Code, and Message. This can help you locate the root cause of a command failure.
Parts in Error
Description
Example
Failure Indicator
Indicates the command failure that happened at a specific input and/or API call.
Update Insight Enrichment failed.
Status Code
The response code issued by the third-party API server or the D3 SOAR system that can be used to locate the corresponding error category. For example, if the returned status code is 401, the selected connection is unauthorized to run the command. The user or system support would need to check the permission setting in the Sumo Logic Cloud SIEM Enterprise (Sumo Logic CSE) portal. Refer to the HTTP Status Code Registry for details.
Status Code: 404.
Message
The raw data or captured key error message from the integration API server about the API request failure.
Message: Insight with ID=xxx not found.
Error Sample Data
Update Insight Enrichment failed.
Status Code: 404.
Message: Insight with ID=xxx not found.
Update Insight Severity
Updates the severity of the specified Insights.
READER NOTE
Insight IDs is a required parameterto run this command.
Run the Fetch Event command to obtain the Insight IDs. Insight IDs can be found in the raw data at the path $.data.objects[*].id.
Input
Input Parameter
Required/Optional
Description
Example
Insight IDs
Required
The IDs of the Insights for which to update severity. Insight IDs can be obtained using the Fetch Event command.
JSON
[ "*****" ]
Severity
Required
The updated severity of the Insights. Available options are:
Critical
High
Medium
Low
High
Output
Return Data
Indicates one of the possible command execution states: Successful, Partially Successful, or Failed.
The Partially Successful state only occurs when a command’s input accepts an array of items (e.g. an array of IP addresses) and one or more items within the array return an error from the API request.
The Failed state can be triggered by any of the following errors:
A connection issue with the integration
The API returned an error message
No response from the API
You can view more details about an error in the Error tab.
Return Data can be passed down directly to a subsequent command or used to create conditional tasks in playbooks.
If the Return Data is Partially Successful or Failed, an Error tab will appear in the Test Result window.
The errortab contains the details responded from D3 SOAR or third-party API calls, including Failure Indicator, Status Code, and Message. This can help you locate the root cause of a command failure.
Parts in Error
Description
Example
Failure Indicator
Indicates the command failure that happened at a specific input and/or API call.
Update Insight Severity failed.
Status Code
The response code issued by the third-party API server or the D3 SOAR system that can be used to locate the corresponding error category. For example, if the returned status code is 401, the selected connection is unauthorized to run the command. The user or system support would need to check the permission setting in the Sumo Logic Cloud SIEM Enterprise (Sumo Logic CSE) portal. Refer to the HTTP Status Code Registry for details.
Status Code: 404.
Message
The raw data or captured key error message from the integration API server about the API request failure.
Message: Insight with ID=xxx not found.
Error Sample Data
Update Insight Severity failed.
Status Code: 404.
Message: Insight with ID=xxx not found.
Update Insight Status And Add Tag
Updates the status of the specified Insights and adds a tag.
READER NOTE
Insight IDs is a required parameterto run this command.
Run the Fetch Event command to obtain the Insight IDs. Insight IDs can be found in the raw data at the path $.data.objects[*].id.
Input
Input Parameter
Required/Optional
Description
Example
Insight IDs
Required
The IDs of the Insights for which to update the status and add a tag. Insight IDs can be obtained using the Fetch Event command.
JSON
[ "*****" ]
Status
Required
The updated status of the Insights. The default statuses available are: new, inprogress, and closed. Additional statuses can be created from Sumo Logic CSE.
closed
Resolution
Optional
The reason for closing the specified Insights. Available options are:
Duplicate
False Positive
No Action
Resolved
Duplicate
Tag Name
Required
The tag name to be added to the specified Insights.
DUPLICATED INSIGHT
Output
Return Data
Indicates one of the possible command execution states: Successful, Partially Successful, or Failed.
The Partially Successful state only occurs when a command’s input accepts an array of items (e.g. an array of IP addresses) and one or more items within the array return an error from the API request.
The Failed state can be triggered by any of the following errors:
A connection issue with the integration
The API returned an error message
No response from the API
You can view more details about an error in the Error tab.
Return Data can be passed down directly to a subsequent command or used to create conditional tasks in playbooks.
If the Return Data is Partially Successful or Failed, an Error tab will appear in the Test Result window.
The errortab contains the details responded from D3 SOAR or third-party API calls, including Failure Indicator, Status Code, and Message. This can help you locate the root cause of a command failure.
Parts in Error
Description
Example
Failure Indicator
Indicates the command failure that happened at a specific input and/or API call.
Update Insight Status And Add Tag failed.
Status Code
The response code issued by the third-party API server or the D3 SOAR system that can be used to locate the corresponding error category. For example, if the returned status code is 401, the selected connection is unauthorized to run the command. The user or system support would need to check the permission setting in the Sumo Logic Cloud SIEM Enterprise (Sumo Logic CSE) portal. Refer to the HTTP Status Code Registry for details.
Status Code: 404.
Message
The raw data or captured key error message from the integration API server about the API request failure.
Message: Insight with ID=xxx not found.
Error Sample Data
Update Insight Status And Add Tag failed.
Status Code: 404.
Message: Insight with ID=xxx not found.
Update Insight Status And Resolution
Updates the status and resolution of the specified Insights.
READER NOTE
Insight IDs is a required parameterto run this command.
Run the Fetch Event command to obtain the Insight IDs. Insight IDs can be found in the raw data at the path $.data.objects[*].id.
Input
Input Parameter
Required/Optional
Description
Example
Insight IDs
Required
The IDs of the Insights for which to update. Insight IDs can be obtained using the Fetch Event command.
JSON
[ "*****" ]
Status
Required
The updated status of the Insights. The default statuses available are: new, inprogress, and closed. Additional statuses can be created from Sumo Logic CSE.
closed
Resolution
Optional
The reason for closing the specified Insights. Available options are:
Duplicate
False Positive
No Action
Resolved
False Positive
Output
Return Data
Indicates one of the possible command execution states: Successful, Partially Successful, or Failed.
The Partially Successful state only occurs when a command’s input accepts an array of items (e.g. an array of IP addresses) and one or more items within the array return an error from the API request.
The Failed state can be triggered by any of the following errors:
A connection issue with the integration
The API returned an error message
No response from the API
You can view more details about an error in the Error tab.
Return Data can be passed down directly to a subsequent command or used to create conditional tasks in playbooks.
If the Return Data is Partially Successful or Failed, an Error tab will appear in the Test Result window.
The errortab contains the details responded from D3 SOAR or third-party API calls, including Failure Indicator, Status Code, and Message. This can help you locate the root cause of a command failure.
Parts in Error
Description
Example
Failure Indicator
Indicates the command failure that happened at a specific input and/or API call.
Update Insight Status And Resolution failed.
Status Code
The response code issued by the third-party API server or the D3 SOAR system that can be used to locate the corresponding error category. For example, if the returned status code is 401, the selected connection is unauthorized to run the command. The user or system support would need to check the permission setting in the Sumo Logic Cloud SIEM Enterprise (Sumo Logic CSE) portal. Refer to the HTTP Status Code Registry for details.
Status Code: 404.
Message
The raw data or captured key error message from the integration API server about the API request failure.
Message: Insight with ID=xxx not found.
Error Sample Data
Update Insight Status And Resolution failed.
Status Code: 404.
Message: Insight with ID=xxx not found.
Update Match List
Updates the status, default time-to-live value, and description of the specified Match List.
READER NOTE
Match List ID is a required parameter to run this command.
Run the List Match Lists command to obtain the Match List ID. Match List IDs can be found in the raw data at the path $.data.objects[*].id.
Input
Input Parameter
Required/Optional
Description
Example
Match List ID
Required
The ID of the Match List in which values require updating. Match List IDs can be obtained using the List Match Lists command.
*****
Active
Optional
Whether to set the Match List as Active. Available options are:
True
False
True
Default Time-to-live
Optional
The updated default time-to-live (in seconds) for new items added to the Match List. This default value is only applicable in the UI and is not applied when new items are added through the API.
14400
Description
Optional
The updated description for the Match List.
Test Desc 0104
Output
Return Data
Indicates one of the possible command execution states: Successful or Failed.
The Failed state can be triggered by any of the following errors:
A connection issue with the integration
The API returned an error message
No response from the API
You can view more details about an error in the Error tab.
Return Data can be passed down directly to a subsequent command or used to create conditional tasks in playbooks.
Provides a brief summary of outputs in an HTML formatted table.
SAMPLE DATA
created
2023-01-04T00:30:43.544042+00:00
createdBy
*****@*****.*****
defaultTtl
14400
description
Test Desc 0104
id
*****
lastUpdated
2023-01-04T20:31:14.520746+00:00
lastUpdatedBy
*****@*****.*****
name
matchListTest1
targetColumn
Hostname
Error Handling
If the Return Data is Failed, an Error tab will appear in the Test Result window.
The errortab contains the details responded from D3 SOAR or third-party API calls, including Failure Indicator, Status Code, and Message. This can help you locate the root cause of a command failure.
Parts in Error
Description
Example
Failure Indicator
Indicates the command failure that happened at a specific input and/or API call.
Update Match List failed.
Status Code
The response code issued by the third-party API server or the D3 SOAR system that can be used to locate the corresponding error category. For example, if the returned status code is 401, the selected connection is unauthorized to run the command. The user or system support would need to check the permission setting in the Sumo Logic Cloud SIEM Enterprise (Sumo Logic CSE) portal. Refer to the HTTP Status Code Registry for details.
Status Code: 404.
Message
The raw data or captured key error message from the integration API server about the API request failure.
Message: Match List with ID=xxx not found.
Error Sample Data
Update Match List failed.
Status Code: 404.
Message: Match List with ID=xxx not found.
Update Match List Item
Updates a Match List Item using the given Match List Item ID.
READER NOTE
Match List Item ID is a required parameter to run this command.
Run the List Match List Items command to obtain the Match List Item ID. Match List Item IDs can be found in the raw data at the path $.data.objects[*].id.
Input
Input Parameter
Required/Optional
Description
Example
Match List Item ID
Required
The ID of the Match List item for which to be updated. Match List Item IDs can be obtained using the List Match List Items command.
*****
Active
Required
Whether to set the Match List Item as Active. Available options are:
True
False
True
Description
Optional
The updated description for the Match List Item.
Test 0104
Expiration
Optional
The updated expiration date and time (in UTC) of the Match List Item.
2023-01-21 00:00
Output
Return Data
Indicates one of the possible command execution states: Successful or Failed.
The Failed state can be triggered by any of the following errors:
A connection issue with the integration
The API returned an error message
No response from the API
You can view more details about an error in the Error tab.
Return Data can be passed down directly to a subsequent command or used to create conditional tasks in playbooks.
If the Return Data is Failed, an Error tab will appear in the Test Result window.
The errortab contains the details responded from D3 SOAR or third-party API calls, including Failure Indicator, Status Code, and Message. This can help you locate the root cause of a command failure.
Parts in Error
Description
Example
Failure Indicator
Indicates the command failure that happened at a specific input and/or API call.
Update Match List Item failed.
Status Code
The response code issued by the third-party API server or the D3 SOAR system that can be used to locate the corresponding error category. For example, if the returned status code is 401, the selected connection is unauthorized to run the command. The user or system support would need to check the permission setting in the Sumo Logic Cloud SIEM Enterprise (Sumo Logic CSE) portal. Refer to the HTTP Status Code Registry for details.
Status Code: 404.
Message
The raw data or captured key error message from the integration API server about the API request failure.
Message: Match List Item with ID=xxx not found.
Error Sample Data
Update Match List Item failed.
Status Code: 404.
Message: Match List Item with ID=xxx not found.
Update Suppress List
Updates the status, default time-to-live, and description of a Suppress List.
READER NOTE
Suppress List ID is a required parameter to run this command.
Run the List Suppress Lists command to obtain the Suppress List ID. Suppress List IDs can be found in the raw data at the path $.data.objects[*].id.
Input
Input Parameter
Required/Optional
Description
Example
Suppress List ID
Required
The ID of the Suppress List in which values require updating. Suppress List IDs can be obtained using the List Suppress Lists command.
*****
Active
Optional
Whether to set the Suppress List as Active. Available options are:
True
False
True
Default Time-to-live
Optional
The updated default time to live (in seconds) for new items added to the Suppress List. This default value is only applicable in the UI and is not applied when new items are added through the API.
14400
Description
Required
The updated description for the Suppress List.
Update Suppressed List 2 Description 0104
Output
Return Data
Indicates one of the possible command execution states: Successful or Failed.
The Failed state can be triggered by any of the following errors:
A connection issue with the integration
The API returned an error message
No response from the API
You can view more details about an error in the Error tab.
Return Data can be passed down directly to a subsequent command or used to create conditional tasks in playbooks.
Common cyber security indicators such as unique IDs, file hash values, CVE numbers, and IP addresses will be extracted from Raw Data as Key Fields.
The system stores these key fields in the path $.[playbookTask].outputData. You can use these key-value pairs as data points for playbook task inputs.
SAMPLE DATA
JSON
{
"SuppressListID": *****,
"SuppressListName": "Test Suppressed List 2",
"Description": "Update Suppressed List 2 Description 0104",
"TargetColumn": "SrcOrg"
}
Result
Provides a brief summary of outputs in an HTML formatted table.
SAMPLE DATA
created
2023-01-04T20:37:24.132531+00:00
createdBy
*****@*****.*****
defaultTtl
14400
description
Update Suppressed List 2 Description 0104
id
*****
lastUpdated
2023-01-04T21:22:54.351331+00:00
lastUpdatedBy
*****@*****.*****
name
Test Suppressed List 2
targetColumn
SrcOrg
Error Handling
If the Return Data is Failed, an Error tab will appear in the Test Result window.
The errortab contains the details responded from D3 SOAR or third-party API calls, including Failure Indicator, Status Code, and Message. This can help you locate the root cause of a command failure.
Parts in Error
Description
Example
Failure Indicator
Indicates the command failure that happened at a specific input and/or API call.
Update Suppress List failed.
Status Code
The response code issued by the third-party API server or the D3 SOAR system that can be used to locate the corresponding error category. For example, if the returned status code is 401, the selected connection is unauthorized to run the command. The user or system support would need to check the permission setting in the Sumo Logic Cloud SIEM Enterprise (Sumo Logic CSE) portal. Refer to the HTTP Status Code Registry for details.
Status Code: 404.
Message
The raw data or captured key error message from the integration API server about the API request failure.
Message: A Match List with id=xx could not be found.
Error Sample Data
Update Suppress List failed.
Status Code: 404.
Message: A Match List with id=xx could not be found.
Update Suppress List Item
Updates Suppress List Item using the given Suppress List Item ID.
READER NOTE
Suppress List Item ID is a required parameterto run this command.
Run the List Suppress List Items command to obtain the Suppress List Item ID. Suppress List IDs can be found in the raw data at the path $.data.objects[*].id.
Input
Input Parameter
Required/Optional
Description
Example
Suppress List Item ID
Required
The ID of the Suppress List item for which to be updated. Suppress List Item IDs can be obtained using the List Suppress List Items command.
*****
Active
Required
Whether to set the Suppress List Item as Active. Available options are:
True
False
True
Description
Optional
The updated description for the Suppress List Item.
Update description 0104
Expiration
Optional
The updated expiration date and time (in UTC) of the Suppress List Item.
2023-01-20 00:00
Output
Return Data
Indicates one of the possible command execution states: Successful or Failed.
The Failed state can be triggered by any of the following errors:
A connection issue with the integration
The API returned an error message
No response from the API
You can view more details about an error in the Error tab.
Return Data can be passed down directly to a subsequent command or used to create conditional tasks in playbooks.
If the Return Data is Failed, an Error tab will appear in the Test Result window.
The errortab contains the details responded from D3 SOAR or third-party API calls, including Failure Indicator, Status Code, and Message. This can help you locate the root cause of a command failure.
Parts in Error
Description
Example
Failure Indicator
Indicates the command failure that happened at a specific input and/or API call.
Update Suppress List Item failed.
Status Code
The response code issued by the third-party API server or the D3 SOAR system that can be used to locate the corresponding error category. For example, if the returned status code is 401, the selected connection is unauthorized to run the command. The user or system support would need to check the permission setting in the Sumo Logic Cloud SIEM Enterprise (Sumo Logic CSE) portal. Refer to the HTTP Status Code Registry for details.
Status Code: 404.
Message
The raw data or captured key error message from the integration API server about the API request failure.
Message: A Match List with id=xx could not be found.
Error Sample Data
Update Suppress List Item failed.
Status Code: 404.
Message: A Match List with id=xx could not be found.
Test Connection
Allows you to perform a health check on an integration connection. You can schedule a periodic health check by selecting Connection Health Check when editing an integration connection.
Input
N/A
Output
Return Data
Indicates one of the possible command execution states: Successful or Failed.
The Failed state can be triggered by any of the following errors:
A connection issue with the integration
The API returned an error message
No response from the API
You can view more details about an error in the Error tab.
Error Handling
If the Return Data is failed, an Error tab will appear in the Test Result window.
The error tab contains the responses from the third-party API calls including Failure Indicator, Status Code, and Message. This can help you locate the root cause of a command failure.
Parts in Error
Description
Example
Failure Indicator
Indicates the command failure that happened at a specific input and/or API call.
Test Connection failed. Failed to check the connector.
Status Code
The response code issued by the third-party API server or the D3 SOAR system that can be used to locate the corresponding error category. For example, if the returned status code is 401, the selected connection is unauthorized to run the command. The user or system support would need to check the permission setting in the Sumo Logic Cloud SIEM Enterprise (Sumo Logic CSE) portal. Refer to the HTTP Status Code Registry for details.
Status Code: 401.
Message
The raw data or captured key error message from the integration API server about the API request failure.
Message: Unauthorized.
Error Sample Data
Test Connection failed. Failed to check the connector.
Status Code: 401.
Message: Unauthorized.
JavaScript errors detected
Please note, these errors can depend on your browser setup.
If this problem persists, please contact our support.
.png)
.png?inst-v=3363bacf-1ba3-4a9b-b554-558cd4632ecc)
