Dell Secureworks Taegis XDR

LAST UPDATED: 05/30/2024

Overview

Secureworks Taegis XDR (formerly Secureworks Red Cloak Threat Detection Response) is a threat-intelligence-based security analytics platform with built-in security context. Secureworks Taegis XDR allows organizations to detect, investigate, and respond to advanced threats across their endpoints, network, and cloud environments.

D3 SOAR is providing REST operations to function with Taegis XDR.

Dell Secureworks Taegis XDR is available for use in:

D3 SOAR	V14.0.27.0+
Category	SIEM XDR
Deployment Options	Option II, Option IV

Connection

To connect to Taegis XDR from D3 SOAR, please follow this part to collect the required information below:

Parameter	Description	Example
Server Url	The server URL of the Taegis XDR API.	https://api.ctpx.secureworks.com
Client ID	The client ID to authenticate the API connection.	c14U************************BUAv
Client Secret	The client secret to authenticate the API connection.	ZxFcecCo************************************************zh-xylPn

Permission Requirements

Each endpoint in the Taegis XDR API requires a certain permission scope. All of the following commands for Taegis XDR can be run by an account with Tenant Auditor permissions: Fetch Event, Search Assets, Search Investigations, Get Threat Intelligence, Get Threat Watch list, Search Alerts, List Countermeasure Rulesets, List Countermeasure Threat Indicators and Test Connection.

As Taegis XDR is using role-based access control (RBAC), the Client ID and Secret are generated based on a specific user account and the application. Therefore, the command permissions are inherited from the user account’s role. Users need to configure their user profile from the Taegis XDR console for each command in this integration.

Reader Note

Taegis XDR’s default user profiles (sorted from the least permissions to the most) are as follows:

Administrator (Tenant Admin)
Analyst (Tenant Analyst)
Responder (Tenant Responder)
Auditor (Tenant Auditor) - Read Only Access

Please refer to User Roles and Profile Settings for details on configuring user profiles. The user you configured and used to login will affect the permission of the obtained client ID and Secret.

Configuring Taegis XDR to Work with D3 SOAR

Reader Note

Taegis™ XDR client credentials can be created by Taegis™ XDR users who have a role of Tenant Analyst or Tenant Admin in the target tenant. The credentials are valid for that one tenant only, and only in the region they were created for. If your application needs to access multiple regions, you must create separate client credentials for each region.

Log in to Taegis XDR with Chrome.
Open the Chrome Developer Tools.
Go to the Console tab, enter the following string, and press Enter. An access_token is copied to your clipboard.
copy(localStorage.access_token)

Reader Note

The access_token token is not displayed in the Chrome Developer Tools Console, and it is only copied to your clipboard. The command returns undefined.

For convenience, paste this access_token to a text editor (e.g. notepad) first. You will need it for the next step.

Open a command line terminal, and run the following commands to create your client credentials.
set ACCESS_TOKEN="your_access_token"
set TENANT_ID="your_tenant_id"
curl -H "Authorization: Bearer %ACCESS_TOKEN%" -H "X-Tenant-Context: %TENANT_ID%" -H "Content-type: application/json" https://api.ctpx.secureworks.com/clients/v1/clients -d "{\"name\":\"your_unique_application_name\"}"
- your_access_token: Paste the access_token you copied from the Chrome developer tools console.
- your_tenant_id: You can get it from Taegis XDR UI: Tenant Settings > Subscriptions
- your_unique_application_name: Enter a unique application name of your choice. The application name must be unique.
Your new client id and client secret are returned. Save the client_id and client_secret values from this response for connecting to D3 VSOC.

Please refer to https://docs.ctpx.secureworks.com/apis/api_authenticate/ for more information.

Configuring D3 SOAR to Work with Dell Secureworks Taegis XDR

Log in to D3 SOAR.
Find the Taegis XDR integration.
1. Navigate to Configuration on the top header menu.
2. Click on the Integration icon on the left sidebar.
3. Type Taegis XDR in the search box to find the integration, then click it to select it.
4. Click + Connection, on the right side of the Connections section. A new connection window will appear.
Configure the following fields to create a connection to Taegis XDR.
1. Connection Name: The desired name for the connection.
2. 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.
3. 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.
4. 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.
5. Description (Optional): Add your desired description for the connection.
6. Tenant (Optional): When configuring the connection from a master tenant site, you have the option 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.
7. Configure User Permissions: Defines which users have access to the connection.
8. Active: Check the tick box to ensure the connection is available for use.
9. System: This section contains the parameters defined specifically for the integration. These parameters must be configured to create the integration connection.
  1. Input your domain level Server URL.
  2. Copy the Client ID from the Taegis XDR platform. Refer to step 5 of Configuring Taegis XDR to Work with D3 SOAR.
  3. Copy the Client Secret from the Taegis XDR platform. Refer to step 5 of Configuring Taegis XDR to Work with D3 SOAR.
10. Enable Password Vault: An optional feature that allows users to take the stored credentials from their own password vault. Please refer to the password vault connection guide if needed.
11. 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.
Test the connection.
1. 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 checkmark appear beside the Test Connection button. If the test connection fails, please check your connection parameters and try again.
2. Click OK to close the alert window.
3. Click + Add to create and add the configured connection.

Commands

Taegis XDR 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 Taegis XDR API, please refer to the Taegis XDR API reference.

Reader Note

Certain permissions are required for each command. Please refer to the Permission Requirements and Configuring Taegis XDR to Work with D3 SOAR for details.

Note for Time-related parameters

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.

Fetch Event

Returns all Taegis XDR alerts matching the specified criteria, including time range.

Reader Note

If no input parameters are defined, the command will return a maximum of 10,000 alerts within the past 24 hours.

Input

Input Parameter	Required/Optional	Description	Example
Start Time	Optional	The start time (in UTC format) of the time range for fetching alerts from Taegis XDR by created time. If this parameter is not defined, the default start time is 24 hours before the end time.	2023-04-27 00:00
End Time	Optional	The end time (in UTC format) of the time range for fetching alerts from Taegis XDR by created time. If this parameter is not defined, the default end time is the current time.	2023-04-28 00:00
Number of Event(s) Fetched	Optional	The number of the most recent events to fetch. The valid value is an integer between 1 and 10000. If this parameter is not defined, the default value is 10000.	10
Search Condition	Optional	The search condition expression to filter the returned results. For more information about the query syntax, refer to the documentation at https://docs.ctpx.secureworks.com/search/querylanguage/advanced_search/#basic-syntax. Note: There is no need to include the "from alert where" clause in your query since it has already been hard coded by D3. You should only state the query language after the "where" keyword.	severity >= 0.75 and status='OPEN'
Tolerance Scope	Optional	The tolerance scope (the default value is 0) in minutes of the query to get events between start and end time to avoid the loss of events. The event will be fetched between {Start Time - Tolerance Scope, End Time}.	0

Output

Raw Data

The primary response data from the API request.

SAMPLE DATA

JSON

{
    "data": {
        "alertsServiceSearch": {
            "alerts": {
                "list": [
                    {
                        "__typename": "Alert2",
                        "attack_technique_ids": [
                            "***",
                            "***",
                            "***"
                        ],
                        "entities": {
                            "entities": [
                                "computerName:***-FILES",
                                "fileName:powershell.exe",
                                "fileName:***.exe",
                                "programMd5:***",
                                "sensorHostId:***",
                                "sensorId:***",
                                "userName:**@***.com"
                            ],
                            "relationships": [
                                {
                                    "from_entity": "fileName:***.exe",
                                    "relationship": "executedOn",
                                    "to_entity": "sensorHostId:**"
                                },
                                {
                                    "from_entity": "fileName:***.exe",
                                    "relationship": "executes",
                                    "to_entity": "fileName:***.exe"
                                },
                                {
                                    "from_entity": "computerName:***-FILES",
                                    "relationship": "isAlso",
                                    "to_entity": "sensorHostId:***"
                                }
                            ]
                        },
                        "id": "alert://priv:event-filter:**:***:***-***-***-***-***",
                        "investigation_ids": null,
                        "metadata": {
                            "began_at": {
                                "seconds": 1662572015
                            },
                            "confidence": 1,
                            "created_at": {
                                "seconds": 1662572628
                            },
                            "creator": {
                                "detector": {
                                    "detector_id": "app:event-filter",
                                    "version": "v0.17.5"
                                },
                                "rule": {
                                    "rule_id": "***-***-***-***-***",
                                    "version": "sha1=**-***"
                                }
                            },
                            "description": "A process event associated with the DLL export function \"MiniDump\" being called was detected. This may indicate that threat actors are attempting to dump the memory of a process to obtain security-related information (encryption keys, credentials, etc.), using functionality built into a standard COM+ services library.\n\nExample:\n> \"C:\\Windows\\system32\\rundll32.exe\" C:\\windows\\System32\\comsvcs.dll MiniDump 644 C:\\lsass.txt full\n\nIn the above example, a threat actor dumped the memory of process ID 644 to file \"C:\\lsass.txt\", indicating that process ID 644 is lsass.exe (Local Security Authority Subsystem Service). The memory of this process contains encryption keys and user password hashes.",
                            "ended_at": {
                                "seconds": 1662572015
                            },
                            "engine": {
                                "name": "app:event-filter"
                            },
                            "inserted_at": {
                                "seconds": 1662572628
                            },
                            "severity": 0.9900000095367432,
                            "title": "DLL Export MiniDump used to dump process memory"
                        },
                        "resolution_reason": "",
                        "sensor_types": [
                            "ENDPOINT_REDCLOAK"
                        ],
                        "status": "OPEN",
                        "suppressed": false,
                        "suppression_rules": null,
                        "tenant_id": "139551"
                    }
                ],
                "total_results": 4
            },
            "reason": "success",
            "status": "OK"
        }
    }
}

Key Fields

Common cyber security indicators such as unique IDs, file hash values, CVE numbers, IP addresses, etc., 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

CODE

{
    "EventTime": [
        "2022-09-07T17:43:48Z"
    ],
    "EventIDs": [
        "alert://priv:event-filter:139551:***:***-***-***-***-***"
    ],
    "EventTypes": [
        "Alert2"
    ],
    "Statuses": [
        "OPEN"
    ],
    "FirstActivityTime": [
        "2022-09-07T17:33:35Z"
    ],
    "LastActivityTime": [
        "2022-09-07T17:33:35Z"
    ],
    "Severities": [
        0.9900000095367432
    ],
    "Titles": [
        "DLL Export MiniDump used to dump process memory"
    ],
    "Descriptions": [
        "A process event associated with the DLL export function \"MiniDump\" being called was detected. This may indicate that threat actors are attempting to dump the memory of a process to obtain security-related information (encryption keys, credentials, etc.), using functionality built into a standard COM+ services library.\n\nExample:\n> \"C:\\Windows\\system32\\rundll32.exe\" C:\\windows\\System32\\comsvcs.dll MiniDump 644 C:\\lsass.txt full\n\nIn the above example, a threat actor dumped the memory of process ID 644 to file \"C:\\lsass.txt\", indicating that process ID 644 is lsass.exe (Local Security Authority Subsystem Service). The memory of this process contains encryption keys and user password hashes."
    ]
}

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.

SAMPLE DATA

CODE

Successful

Result

Provides a brief summary of outputs in an HTML formatted table.

SAMPLE DATA

data

{'alertsServiceSearch': {'alerts': {'list': [{'__typename': 'Alert2', 'attack_technique_ids': ['***', '***', '**', '***'], 'entities': {'entities': ['computerName:OCTO-FILES', 'fileName:**8.exe', 'fileName:**.exe', 'programMd5:***', 'sensorHostId:**', 'sensorId:***', 'userName:test@example.com'], 'relationships': [{'from_entity': 'fileName:***.exe', 'relationship': 'executedOn', 'to_entity': 'sensorHostId:**'}, {'from_entity': 'fileName:powershell.exe', 'relationship': 'executes', 'to_entity': 'fileName:***.exe'}, {'from_entity': 'computerName:OCTO-FILES', 'relationship': 'isAlso', 'to_entity': 'sensorHostId:***'}]}, 'id': 'alert://priv:event-filter:**:***:***-***-***-***-***', 'investigation_ids': None, 'metadata': {'began_at': {'seconds': 1662572015}, 'confidence': 1, 'created_at': {'seconds': 1662572628}, 'creator': {'detector': {'detector_id': 'app:event-filter', 'version': 'v0.17.5'}, 'rule': {'rule_id': '***-***-***-***-***', 'version': 'sha1=***-***'}}, 'description': 'A process event associated with the DLL export function "MiniDump" being called was detected. This may indicate that threat actors are attempting to dump the memory of a process to obtain security-related information (encryption keys, credentials, etc.), using functionality built into a standard COM+ services library.\n\nExample:\n> "C:\\Windows\\***\\***.exe" C:\\windows\\**\\***.dll MiniDump ***C:\\***.txt full\n\nIn the above example, a threat actor dumped the memory of process ID **to file "C:\\**.txt", indicating that process ID ***is lsass.exe (Local Security Authority Subsystem Service). The memory of this process contains encryption keys and user password hashes.', 'ended_at': {'seconds': ***}, 'engine': {'name': 'app:event-filter'}, 'inserted_at': {'seconds': ***}, 'severity': ***, 'title': 'DLL Export MiniDump used to dump process memory'}, 'resolution_reason': '', 'sensor_types': ['ENDPOINT_REDCLOAK'], 'status': 'OPEN', 'suppressed': False, 'suppression_rules': None, 'tenant_id': '***'}], 'total_results': 4}, 'reason': 'success', 'status': 'OK'}}

Fetch Event Field Mapping

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 Taegis XDR 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.alertsServiceSearch.alerts.list) that is used to extract a batch of events from the response raw data. Click Edit Event Source to view the “Main Event JSON Path”.
- Main Event JSON Path: $.data.alertsServiceSearch.alerts.list
  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.alertsServiceSearch.alerts.list. 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.alertsServiceSearch.alerts.list.id.

The pre-configured field mappings are detailed below:

Field Name	Source Field
Unique Event Key	.id
Event Type	.__typename
Start Time	.metadata.created_at.seconds
Description	.metadata.description
Techniques	.attack_technique_ids
Severity	.metadata.severity
Status	.status
First Behavior Time	.metadata.began_at.seconds
Last Behavior Time	.metadata.ended_at.seconds
Message	.metadata.title
Entities	.entities.entities

Error Handling

If the Return Data is Failed, an Error tab will appear in the Test Result window.

The error tab 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 Taegis XDR 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: Invalid Query.

Error Sample Data

Fetch Event failed.

Status Code: 400.

Message: Invalid Query.

Get Threat Intelligence

Retrieves threat intelligence on the specified indicators.

Input

Input Parameter	Required/Optional	Description	Example
Indicators	Required	The indicators to retrieve corresponding threat intelligence.	[ "40.00.000.000" ]

Output

Raw Data

The primary response data from the API request.

SAMPLE DATA

JSON

[
    {
        "data": {
            "threatIndicatorIntelligence": {
                "groups": [
                    {
                        "group": {
                            "id": "COBALT DICKENS",
                            "sharing_id": "intrusion-set--***-***-***-***-***"
                        }
                    }
                ],
                "identities": null,
                "indicator": {
                    "description": "malicious",
                    "id": "***.tk",
                    "indicator_types": [
                        "malicious_activity"
                    ],
                    "location": null,
                    "mitre_attack_categories": null,
                    "name": "vitl.tk",
                    "pattern": "[domain:value= '**.tk']",
                    "score": null,
                    "sharing_id": "indicator--***-***-***-***-***"
                },
                "malware": null,
                "reports": [
                    {
                        "report": {
                            "id": "scwx_tip:COBALT DICKENS operations continue with expanded targeting",
                            "name": "[CTU TIP] COBALT DICKENS operations continue with expanded targeting",
                            "sharing_id": "report--***-***-***-***-***"
                        }
                    },
                    {
                        "report": {
                            "id": "scwx_tip:Iranian cyberespionage operations continue",
                            "name": "[CTU TIP] Iranian cyberespionage operations continue",
                            "sharing_id": "report--***-***-***-***-***"
                        }
                    },
                    {
                        "report": {
                            "id": "scwx_tip:COBALT DICKENS campaign leverages free resources",
                            "name": "[CTU TIP] COBALT DICKENS campaign leverages free resources",
                            "sharing_id": "report--***-***-***-***-***"
                        }
                    }
                ]
            }
        }
    }
]

Key Fields

Common cyber security indicators such as unique IDs, file hash values, CVE numbers, IP addresses, etc., 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

CODE

{
    "IndicatorNames": [
        "40.00.000.000"
    ],
    "IndicatorIDs": [
        "40.00.000.000"
    ],
    "SharingIDs": [
        "indicator--***-***-***-***-***"
    ]
}

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

Result

Provides a brief summary of outputs in an HTML formatted table.

SAMPLE DATA

DATA
{'threatIndicatorIntelligence': {'groups': [{'group': {'id': '***

Error Handling

If the Return Data is Failed, an Error tab will appear in the Test Result window.

The error tab 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 Threat Intelligence 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 Taegis XDR 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: Invalid Indicator.

Error Sample Data

Get Threat Intelligence failed.

Status Code: 400.

Message: Invalid Indicator.

Get Threat Watchlist

Retrieves a threat watchlist of the specified indicator type.

Input

Input Parameter	Required/Optional	Description	Example
Indicator Types	Required	The indicator type to retrieve the threat watchlist. The available indicator types are Domain, File, and IP.	Domain

Output

Raw Data

The primary response data from the API request.

SAMPLE DATA

JSON

{
    "data": {
        "threatWatchlist": [
            {
                "confidence": 90,
                "description": "TIPS 9674 - PhantomNet C2 server",
                "id": "CTU TIPS Domain Indicators|lists|***.com",
                "indicator_class": "domain",
                "label": "relationship",
                "mitre_attack_categories": [],
                "sharing_id": "relationship--***-***-***-***-***",
                "source_internal": true,
                "source_ref": "CTU TIPS Domain Indicators",
                "src_desc": "A list of domains from CTU TIPS alerts",
                "start_time": "2022-08-26T07:19:50Z",
                "stop_time": "2022-09-09T07:19:50Z",
                "tags": [
                    "domain",
                    "high_confidence"
                ],
                "target_ref": "ny.***.com",
                "tgt_desc": "malicious",
                "type": "relationship"
            },
            {
                "confidence": 90,
                "description": "TIPS 9674 - PhantomNet C2 server",
                "id": "CTU TIPS Domain Indicators|lists|www.sinnb.com",
                "indicator_class": "domain",
                "label": "relationship",
                "mitre_attack_categories": [],
                "sharing_id": "relationship--***-***-***-***-***",
                "source_internal": true,
                "source_ref": "CTU TIPS Domain Indicators",
                "src_desc": "A list of domains from CTU TIPS alerts",
                "start_time": "2022-08-26T07:19:50Z",
                "stop_time": "2022-09-09T07:19:50Z",
                "tags": [
                    "domain",
                    "high_confidence"
                ],
                "target_ref": "www.sinnb.com",
                "tgt_desc": "malicious",
                "type": "relationship"
            }
        ]
    }
}

Key Fields

Common cyber security indicators such as unique IDs, file hash values, CVE numbers, IP addresses, etc., 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

CODE

{
    "IDs": [
        "CTU TIPS Domain Indicators|lists|***.com"
    ],
    "Descriptions": [
        "TIPS 9674 - PhantomNet C2 server"
    ],
    "SharingIDs": [
        "relationship--***-***-***-***-***"
    ],
    "IndicatorNames": [
        "ny.nsd-gov-pk.com"
    ]
}

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

Result

Provides a brief summary of outputs in an HTML formatted table.

SAMPLE DATA

data	{'threatWatchlist': [{'confidence': 90, 'description': 'TIPS 9674 - PhantomNet C2 server', 'id': 'CTU TIPS Domain *'}]}

Error Handling

If the Return Data is Failed, an Error tab will appear in the Test Result window.

The error tab 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 Threat Watchlist 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 Taegis XDR portal. Refer to the HTTP Status Code Registry for details.	Status Code: 403.
Message	The raw data or captured key error message from the integration API server about the API request failure.	Message: Forbidden.

Error Sample Data

Get Threat Watchlist failed.

Status Code: 403.

Message: Forbidden.

List Countermeasure Rulesets

Returns Counter Threat Unit (CTU) countermeasure rulesets.

Input

N/A

Output

Raw Data

The primary response data from the API request.

Note: The query parameter "html" has been hardcoded to "true" to obtain the countermeasure rulesets.

SAMPLE DATA

JSON

[
    {
        "name": "ti-ruleset/S***.tgz",
        "link": "https://***"
    },
    {
        "name": "ti-ruleset/***.tgz",
        "link": "https://***"
    }
]

Key Fields

Common cyber security indicators such as unique IDs, file hash values, CVE numbers, IP addresses, etc., 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

CODE

{
    "Names": [
        "ti-ruleset/***.tgz"
    ],
    "Links": [
        "https://***"
    ]
}

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

Result

Provides a brief summary of outputs in an HTML formatted table.

SAMPLE DATA

NAME	LINK
ti-ruleset/Snort_talos-supplement_latest.tgz	https://***

Error Handling

If the Return Data is Failed, an Error tab will appear in the Test Result window.

The error tab 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 Countermeasure Rulesets 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 Taegis XDR portal. Refer to the HTTP Status Code Registry for details.	Status Code: 403.
Message	The raw data or captured key error message from the integration API server about the API request failure.	Message: Forbidden.

Error Sample Data

List Countermeasure Rulesets failed.

Status Code: 403.

Message: Forbidden.

List Countermeasure Threat Indicators

Retrieves the versions of Threat Indicator Lists released by the CTU. You have the option to retrieve all versions of the Threat Indicator Lists or only the most recent ones.

Input

Input Parameter	Required/Optional	Description	Example
Version	Required	The option to retrieve all or the most recent versions of Threat Indicator Lists.	All Versions

Output

Raw Data

The primary response data from the API request.

Note: The query parameters "filter" and "html" have been hardcoded to "all" and "true" respectively to obtain the threat indicators.

SAMPLE DATA

JSON

[
    {
        "name": "scwx-attackerdb/domainname/42/***.csv",
        "link": "https://***"
    },
    {
        "name": "scwx-attackerdb/domainname/44/***.csv",
        "link": "https://***"
    }
]

Key Fields

Common cyber security indicators such as unique IDs, file hash values, CVE numbers, IP addresses, etc., 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

CODE

{
    "Names": [
        "***.csv"
    ],
    "Links": [
        "https://***"
    ]
}

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

Result

Provides a brief summary of outputs in an HTML formatted table.

SAMPLE DATA

NAME	LINK
***.csv	***

Error Handling

If the Return Data is Failed, an Error tab will appear in the Test Result window.

The error tab 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 Countermeasure Threat Indicators 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 Taegis XDR portal. Refer to the HTTP Status Code Registry for details.	Status Code: 403.
Message	The raw data or captured key error message from the integration API server about the API request failure.	Message: Forbidden.

Error Sample Data

List Countermeasure Threat Indicators failed.

Status Code: 403.

Message: Forbidden.

Search Alerts

Retrieves alerts matching the given criteria.

Input

Input Parameter	Required/Optional	Description	Example
Start Time	Optional	The start time (in UTC format) of the time range for searching alerts. The start time corresponds to the specified query time type. If this parameter is not defined, the default start time is 24 hours before the end time.	2023-05-01 00:00
End Time	Optional	The end time (in UTC format) of the time range for searching alerts. The end time corresponds to the specified query time type. If this parameter is not defined, the default end time is the current time.	2023-05-02 00:00
Query Time Type	Required	The time field to search for alerts. The available time fields to search by are First Activity Time, Last Activity Time, Created Time and Inserted Time.	First Activity Time
Limit	Optional	The number of the most recent events to fetch. The valid value is an integer between 1 and 10000. If this parameter is not defined, the default value is 10000.	10
Query	Optional	The query expression to filter the returned results. For more information about the query syntax, refer to the documentation at https://docs.ctpx.secureworks.com/search/querylanguage/advanced_search/#basic-syntax. Note: There is no need to include the "from alert where" clause in your query since it has already been hard coded by D3. You should only state the query language after the "where" keyword.	severity >= 0.75 and status='OPEN'

Output

Raw Data

The primary response data from the API request.

SAMPLE DATA

JSON

{
    "data": {
        "alertsServiceSearch": {
            "alerts": {
                "list": [
                    {
                        "__typename": "Alert2",
                        "attack_technique_ids": [
                            "***",
                            "***",
                            "***",
                            "***",
                            "***",
                            "***",
                            "***",
                            "***"
                        ],
                        "entities": {
                            "entities": [
                                "computerName:***-FILES",
                                "fileName:***.exe",
                                "fileName:***.exe",
                                "programMd5:***",
                                "sensorHostId:***",
                                "sensorId:***",
                                "userName:test@example.com"
                            ],
                            "relationships": [
                                {
                                    "from_entity": "***:***.exe",
                                    "relationship": "executedOn",
                                    "to_entity": "sensorHostId:***"
                                },
                                {
                                    "from_entity": "fileName:**.exe",
                                    "relationship": "executes",
                                    "to_entity": "fileName:***.exe"
                                },
                                {
                                    "from_entity": "computerName:**-FILES",
                                    "relationship": "isAlso",
                                    "to_entity": "sensorHostId:***"
                                }
                            ]
                        },
                        "id": "alert://priv:event-filter:***:*8:***-***-***-***-***",
                        "investigation_ids": null,
                        "metadata": {
                            "began_at": {
                                "seconds": 1662572015
                            },
                            "confidence": 1,
                            "created_at": {
                                "seconds": 1662572628
                            },
                            "creator": {
                                "detector": {
                                    "detector_id": "app:***",
                                    "version": "v0.17.5"
                                },
                                "rule": {
                                    "rule_id": "6***-***-***-***-***",
                                    "version": "sha1=***-***"
                                }
                            },
                            "description": "A process event associated with the DLL export function \"MiniDump\" being called was detected. This may indicate that threat actors are attempting to dump the memory of a process to obtain security-related information (encryption keys, credentials, etc.), using functionality built into a standard COM+ services library.\n\nExample:\n> \"C:\\Windows\\system32\\rundll32.exe\" C:\\windows\\System32\\comsvcs.dll MiniDump 644 C:\\lsass.txt full\n\nIn the above example, a threat actor dumped the memory of process ID 644 to file \"C:\\lsass.txt\", indicating that process ID 644 is lsass.exe (Local Security Authority Subsystem Service). The memory of this process contains encryption keys and user password hashes.",
                            "ended_at": {
                                "seconds": 1662572015
                            },
                            "engine": {
                                "name": "app:event-filter"
                            },
                            "inserted_at": {
                                "seconds": 1662572628
                            },
                            "severity": 0.9900000095367432,
                            "title": "DLL Export MiniDump used to dump process memory"
                        },
                        "resolution_reason": "",
                        "sensor_types": [
                            "ENDPOINT_REDCLOAK"
                        ],
                        "status": "OPEN",
                        "suppressed": false,
                        "suppression_rules": null,
                        "tenant_id": "***"
                    }
                ],
                "total_results": 4
            },
            "reason": "success",
            "status": "OK"
        }
    }
}

Key Fields

Common cyber security indicators such as unique IDs, file hash values, CVE numbers, IP addresses, etc., 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

CODE

{
    "EventTime": [
        "2022-09-07T17:43:48Z"
    ],
    "EventIDs": [
        "alert://priv:event-filter:***-***-***-***-***"
    ],
    "EventTypes": [
        "Alert2"
    ],
    "Statuses": [
        "OPEN"
    ],
    "FirstActivityTime": [
        "2022-09-07T17:33:35Z"
    ],
    "LastActivityTime": [
        "2022-09-07T17:33:35Z"
    ],
    "Severities": [
        0.9900000095367432
    ],
    "Titles": [
        "DLL Export MiniDump used to dump process memory"
    ],
    "Descriptions": [
        "A process event associated with the DLL export function \"MiniDump\" being called was detected. This may indicate that threat actors are attempting to dump the memory of a process to obtain security-related information (encryption keys, credentials, etc.), using functionality built into a standard COM+ services library.\n\nExample:\n> \"C:\\Windows\\system32\\rundll32.exe\" C:\\windows\\System32\\comsvcs.dll MiniDump 644 C:\\lsass.txt full\n\nIn the above example, a threat actor dumped the memory of process ID 644 to file \"C:\\lsass.txt\", indicating that process ID 644 is lsass.exe (Local Security Authority Subsystem Service). The memory of this process contains encryption keys and user password hashes."
    ]
}

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

Result

Provides a brief summary of outputs in an HTML formatted table.

SAMPLE DATA

data

***

Error Handling

If the Return Data is Failed, an Error tab will appear in the Test Result window.

The error tab 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.	Search Alerts 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 Taegis XDR 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: Invalid Queries.

Error Sample Data

Search Alerts failed.

Status Code: 400.

Message: Invalid Queries.

Search Assets

Retrieves endpoints matching the given criteria.

Input

Input Parameter	Required/Optional	Description	Example
Limit	Optional	The maximum number of assets to return. The valid input value is an integer between 1 and 100. If this parameter is not specified, all assets matching the specified endpoint state will be returned.	10
Endpoint State	Required	The state of the endpoints to return.	Active

Output

Raw Data

The primary response data from the API request.

SAMPLE DATA

JSON

{
    "data": {
        "allAssets": {
            "assets": [
                {
                    "createdAt": "2022-09-12T20:34:39.046587Z",
                    "endpointPlatform": "",
                    "endpointType": "ENDPOINT_REDCLOAK",
                    "ethernetAddresses": [
                        {
                            "id": "***-***-***-***-***",
                            "mac": "00:ff:00:ff:fe:0:0d:00"
                        },
                        {
                            "id": "***-***-***-***-***",
                            "mac": "00:00:00:ff:fe:b0:ea:cb"
                        },
                        {
                            "id": "***-***-***-***-***",
                            "mac": "00:00:00:ff:fe:b0:b0:0f"
                        }
                    ],
                    "hostId": "***-***-***-***-***",
                    "hostnames": [
                        {
                            "hostId": "***-***-***-***-***",
                            "hostname": "***"
                        }
                    ],
                    "id": "***-***-***-***-***",
                    "ingestTime": "2022-09-13T14:29:59Z",
                    "ipAddresses": [
                        {
                            "hostId": "**",
                            "ip": "1.2.2.2"
                        },
                        {
                            "hostId": "***",
                            "ip": "1.2.2.2"
                        }
                    ],
                    "osFamily": "WINDOWS",
                    "osVersion": "VERSION_WIN10",
                    "sensorId": "***",
                    "sensorTenant": "***",
                    "sensorVersion": "2.8.3.0",
                    "updatedAt": "2022-09-13T14:44:31.164743Z",
                    "users": []
                },
                {
                    "createdAt": "2022-09-12T23:41:47.260448Z",
                    "endpointPlatform": "",
                    "endpointType": "ENDPOINT_REDCLOAK",
                    "ethernetAddresses": [
                        {
                            "id": "***-***-***-***-***",
                            "mac": "00:00:00:ff:fe:b0:00:cf"
                        }
                    ],
                    "hostId": "***",
                    "hostnames": [
                        {
                            "hostId": "***",
                            "hostname": "***"
                        }
                    ],
                    "id": "***-***-***-***-***",
                    "ingestTime": "2022-09-13T14:49:48Z",
                    "ipAddresses": [
                        {
                            "hostId": "***",
                            "ip": "1.2.2.2"
                        }
                    ],
                    "osFamily": "WINDOWS",
                    "osVersion": "VERSION_SERVER_2019",
                    "sensorId": "***",
                    "sensorTenant": "**",
                    "sensorVersion": "2.8.3.0",
                    "updatedAt": "2022-09-13T16:08:14.140143Z",
                    "users": []
                }
            ],
            "totalResults": 2
        }
    }
}

Key Fields

Common cyber security indicators such as unique IDs, file hash values, CVE numbers, IP addresses, etc., 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

CODE

{
    "Hostnames": [
        "***"
    ],
    "HostIDs": [
        "***"
    ],
    "OSVersions": [
        "VERSION_WIN10"
    ]
}

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

Result

Provides a brief summary of outputs in an HTML formatted table.

SAMPLE DATA

data

***

Error Handling

If the Return Data is Failed, an Error tab will appear in the Test Result window.

The error tab 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.	Search Assets 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 Taegis XDR portal. Refer to the HTTP Status Code Registry for details.	Status Code: 403.
Message	The raw data or captured key error message from the integration API server about the API request failure.	Message: Forbidden.

Error Sample Data

Search Assets failed.

Status Code: 403.

Message: Forbidden.

Search Investigations

Retrieves investigations matching the given criteria.

Input

Input Parameter	Required/Optional	Description	Example
Start Time	Optional	The start time (in UTC format) of the time range for searching investigations. The start time corresponds to the specified query time type. If this parameter is not defined, the default start time is 24 hours before the end time.	2023-05-01 00:00
End Time	Optional	The end time (in UTC format) of the time range for searching investigations. The end time corresponds to the specified query time type. If this parameter is not defined, the default end time is the current time.	2023-05-02 00:00
Query Time Type	Required	The time field to search for investigations. The available time fields to search by are Created Time, Updated Time and Notified Time.	Updated Time
Limit	Optional	The maximum number of investigations to return. The valid value is an integer between 1 and 100. If this parameter is not defined, all investigations matching the search conditions will be returned.	10
Query	Optional	The query expression to filter the returned results. For more information about the query syntax, refer to the documentation at https://docs.ctpx.secureworks.com/search/querylanguage/advanced_search/#basic-syntax.	type in ('Security Investigation') priority =2
Filter Text	Optional	The string for a free text search.	Test-A

Output

Raw Data

The primary response data from the API request.

SAMPLE DATA

JSON

{
    "data": {
        "investigationsSearch": {
            "investigations": [
                {
                    "alerts": [],
                    "archived_at": null,
                    "assets": [],
                    "assignee_id": "auth0|***",
                    "auth_credentials": [],
                    "contributors": [],
                    "created_at": "2022-09-07T19:30:07.118464Z",
                    "created_by": "auth0|***",
                    "created_by_partner": false,
                    "created_by_scwx": false,
                    "description": "Test-A",
                    "events": [],
                    "genesis_alerts": [],
                    "genesis_events": [],
                    "id": "***-***-***-***-***",
                    "key_findings": "",
                    "notified_at": null,
                    "priority": 2,
                    "search_queries": [],
                    "service_desk_id": "",
                    "service_desk_type": "",
                    "status": "Open",
                    "tags": [],
                    "tenant_id": "***",
                    "type": "Security Investigation",
                    "updated_at": "2022-09-07T19:30:19.469463Z"
                }
            ],
            "totalCount": 1
        }
    }
}

Key Fields

Common cyber security indicators such as unique IDs, file hash values, CVE numbers, IP addresses, etc., 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

CODE

{
    "CreatedTime": [
        "2022-09-07T19:30:07.118464Z"
    ],
    "UpdatedTime": [
        "2022-09-07T19:30:19.469463Z"
    ],
    "InvestigationIDs": [
        "***-***-***-***-***"
    ],
    "Statuses": [
        "Open"
    ],
    "Types": [
        "Security Investigation"
    ],
    "Priorities": [
        2
    ],
    "Descriptions": [
        "Test-A"
    ],
    "AssigneeIDs": [
        "auth0|***"
    ]
}

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

Result

Provides a brief summary of outputs in an HTML formatted table.

SAMPLE DATA

data

{'investigationsSearch': {'investigations': [{'alerts': [], 'archived_at': None, 'assets': [], 'assignee_id': 'auth0|***', 'auth_credentials': [], 'contributors': [], 'created_at': '2022-09-07T19:30:07.118464Z', 'created_by': 'auth0|***', 'created_by_partner': False, 'created_by_scwx': False, 'description': 'Test-A', 'events': [], 'genesis_alerts': [], 'genesis_events': [], 'id': '***-***-***-***-***', 'key_findings': '', 'notified_at': None, 'priority': 2, 'search_queries': [], 'service_desk_id': '', 'service_desk_type': '', 'status': 'Open', 'tags': [], 'tenant_id': '***', 'type': 'Security Investigation', 'updated_at': '2022-09-07T19:30:19.469463Z'}], 'totalCount': 1}}

Error Handling

If the Return Data is Failed, an Error tab will appear in the Test Result window.

The error tab 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.	Search Investigations 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 Taegis XDR 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: Invalid Query.

Error Sample Data

Search Investigations failed.

Status Code: 400.

Message: Invalid Query.

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.

SAMPLE DATA

CODE

Successful

Error Handling

If the Return Data is Failed, an Error tab will appear in the Test Result window.

The error tab 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.	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 Taegis XDR portal. Refer to the HTTP Status Code Registry for details.	Status Code: 403.
Message	The raw data or captured key error message from the integration API server about the API request failure.	Message: Forbidden.

Error Sample Data

Test Connection failed. Failed to check the connector.

Status Code: 403.

Message: Forbidden.