Proofpoint Threat Response

LAST UPDATED: OCT 31, 2024

Overview

Proofpoint Threat Response is designed for security operations teams working towards security maturity. This solution automates the threat data enrichment, forensic verification and response processes after security teams receive an alert. Unlike traditional incident response tools, Threat Response automatically confirms malware infections, checks for evidence of past infections, and enriches security alerts by automatically adding internal and external context and intelligence. Proofpoint Threat Response Auto-Pull (TRAP) provides security teams with orchestration and automation capabilities to retract malicious emails delivered to user inboxes. TRAP is an entry-level version of Threat Response, which removes internal copies of malicious emails based on alerts from TAP and implements additional business logic to find and remove internal copies of that messages that were forwarded to others.

D3 SOAR is providing REST operations to function with Proofpoint Threat Response.

Proofpoint Threat Response is available for use in:

D3 SOAR	V16.0+
Category	SIEM & XDR
Deployment Options	Option II, Option IV

Connection

To connect to Proofpoint Threat Response from D3 SOAR, please follow this part to collect the required information below:

Parameter	Description	Example
Server URL	The URL of the Proofpoint Threat Response/TRAP server.	https://{{PTR_IP_Address}}
API Key	The API key obtained from the PTR (Proofpoint Threat Response) UI.	******
API Version	The API Version of the integration. Please note, at present, API Version only applies to the Get Alert Details command.	v1

Configuring Proofpoint Threat Response to Work with D3 SOAR

Please refer to https://ptr-docs.proofpoint.com/extensibility-guides/ptr-api/#authentication for API Key setups.

Configuring D3 SOAR to Work with Proofpoint Threat Response

Log in to D3 SOAR.
Find the Proofpoint Threat Response integration.
1. Navigate to Configuration on the top header menu.
2. Click on the Integration icon on the left sidebar.
3. Type Proofpoint Threat Response 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 Proofpoint Threat Response.
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. Input your API Token.
  3. Input the API Version. The default value is v1.
10. 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.
11. 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.
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

Proofpoint Threat Response 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 Proofpoint Threat Response API, please refer to the Proofpoint Threat Response API reference.

READER NOTE

Certain permissions are required for each command. Please refer to the Permission Requirements and Configuring Proofpoint Threat Response 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.

Add Incident Comments

Adds comments to the specified incident(s).

READER NOTE

The parameter Incident IDs is required to run this command.

Run the Fetch Event command to obtain Incident IDs. Incident IDs can be found in the raw data at the path $[*].id.

Input

Input Parameter	Required/Optional	Description	Example
Incident IDs	Required	The ID(s) of incident(s) to which the comments are added. Incident IDs can be obtained using the Fetch Event command.	[ ***]
Summary	Required	The summary of the comments.	comments here
Details	Optional	The details of the comments.	details here

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

CODE

[
    {
        "id": ***,
        "incident_id": ***,
        "response_id": null,
        "user_id": null,
        "history_type": "comment",
        "state_from": "none",
        "state_to": "none",
        "summary": "comments here",
        "detail": "details here",
        "created_at": "2017-01-17T20:58:38Z",
        "updated_at": "2017-01-17T20:58:38Z"
    }
]

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

{
    "IncidentIDs": [
        ***
    ],
    "CommentIDs": [
        ***
    ],
    "CreatedTime": [
        "2017-01-17T20:58:38Z"
    ]
}

Result

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

SAMPLE DATA

CODE

No Sample Data

Error Handling

If the Return Data is Partially Successful or 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.	Add Incident 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 Proofpoint Threat Response 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: Name or service not known.

Error Sample Data

Add Incident Comments failed.

Status Code: 400.

Message: Name or service not known.

Add Users To Incidents

Assigns user(s) to the specified incident(s) as targets or attackers.

READER NOTE

The parameter Incident IDs is required to run this command.

Run the Fetch Event command to obtain Incident IDs. Incident IDs can be found in the raw data at the path $[*].id.

Input

Input Parameter	Required/Optional	Description	Example
Incident IDs	Required	The ID(s) of the incident(s) to which the users are added. Incident IDs can be obtained using the Fetch Event command.	[ ***]
Targets	Required	The list of targets to add to the incident(s).	["user1"]
Attackers	Required	The list of attackers to add to the incident(s).	[ "user2" ]

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

CODE

[
    {
        "incident_id": ***,
        "message": "Add users to the incident successfully."
    }
]

Result

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

SAMPLE DATA

CODE

N Sample Data

Error Handling

If the Return Data is Partially Successful or 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.	Add Users To Incidents 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 Proofpoint Threat Response 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: Name or service not known.

Error Sample Data

Add Users To Incidents failed.

Status Code: 400.

Message: Name or service not known.

Block Hashes

Adds the specified URL(s) to the specified File block list.

READER NOTE

File Block List ID is a required parameter to run this command.

Please refer to the step below to get the List ID from UI:
- Login to Proofpoint Threat Response.
- Navigate to the Lists page and go to the sub-tab corresponding to the list you are searching for.
- Click on the desired list to display the list details.
- Review the URL in your browser’s address bar; the ID will be at the end of the URL.

Input

Input Parameter	Required/Optional	Description	Example
File Block List ID	Required	The ID of the File Block List to which the file hashes are added.	***
Hashes	Required	The File Hash(es) to be added to the File Block List.	[ "******" ]
Description	Optional	The short description for the File Hash(es) that are to be blocked.	File Hash to block
Expiration Time	Optional	The time when the block will expire. If not specified, the block will remain in effect indefinitely.	2018-12-18 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

CODE

[
    {
        "id": ***,
        "list_id": ***,
        "hash_id": ***,
        "response_id": null,
        "reverse_user_id": null,
        "hash_reputation_id": null,
        "user_id": null,
        "enabled": true,
        "deleted": false,
        "description": "File Hash to block",
        "expiration": "2018-12-18T19:08:56Z",
        "created_at": "2017-01-11T03:47:15Z",
        "updated_at": "2017-01-11T03:47:15Z",
        "hash": {
            "created_at": "2017-01-11T03:47:15Z",
            "hash": "***",
            "id": ***,
            "resolution_state": 4,
            "ttl": 0,
            "updated_at": "2017-01-11T03:47:15Z"
        }
    }
]

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

{
      "ListIDs": [
          ***
      ],
      "MemberIDs": [
          ***
      ],
      "Descriptions": [
          "File Hash to block"
      ]
}

Result

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

SAMPLE DATA

CODE

No Sample Data

Error Handling

If the Return Data is Partially Successful or 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.	Block Hashes 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 Proofpoint Threat Response 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: Name or service not known.

Error Sample Data

Block Hashes failed.

Status Code: 400.

Message: Name or service not known.

Block IPs

Adds the specified IP address(es) to the specified IP block list.

READER NOTE

IP Block List ID is a required parameter to run this command.

Please refer to the step below to get the List ID from UI:
- Login to Proofpoint Threat Response.
- Navigate to the Lists page and go to the sub-tab corresponding to the list you are searching for.
- Click on the desired list to display the list details.
- Review the URL in your browser’s address bar; the ID will be at the end of the URL.

Input

Input Parameter	Required/Optional	Description	Example
IP Block List ID	Required	The ID of the IP Block List to which the IP addresses will be added.	***
IP Addresses	Required	The IP address(es) to be added to the IP Block List.	[ "1.1.1.1" ]
Description	Optional	The short description for the IP address(es) to be blocked.	IP to block
Expiration Time	Optional	The time when the block will expire; if not specified, the block will not expire automatically.	2018-12-18 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

CODE

[
    {
        "id": ***,
        "list_id": ***,
        "host_id": ***,
        "response_id": null,
        "reverse_user_id": null,
        "hash_reputation_id": null,
        "user_id": null,
        "enabled": true,
        "deleted": false,
        "description": "IP to block",
        "expiration": "2018-12-18T19:08:56Z",
        "created_at": "2017-01-11T03:47:15Z",
        "updated_at": "2017-01-11T03:47:15Z",
        "host": {
            "created_at": "2017-01-11T03:47:15Z",
            "host": "******",
            "id": ***,
            "resolution_state": 4,
            "ttl": 0,
            "updated_at": "2017-01-11T03:47:15Z"
        }
    }
]

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

{
      "ListIDs": [
          ***
      ],
      "MemberIDs": [
          ***
      ],
      "Descriptions": [
          "IP to block"
      ]
}

Result

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

SAMPLE DATA

CODE

No Sample Data

Error Handling

If the Return Data is Partially Successful or 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.	Block IPs 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 Proofpoint Threat Response 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: Name or service not known.

Error Sample Data

Block IPs failed.

Status Code: 400.

Message: Name or service not known.

Block URLs

Adds the specified URL(s) to the specified URL block list.

READER NOTE

URL Block List ID is a required parameter to run this command.

Please refer to the step below to get the List ID from UI:
- Login to Proofpoint Threat Response.
- Navigate to the Lists page and go to the sub-tab corresponding to the list you are searching for.
- Click on the desired list to display the list details.
- Review the URL in your browser’s address bar; the ID will be at the end of the URL.

Input

Input Parameter	Required/Optional	Description	Example
URL Block List ID	Required	The ID of the URL Block List to which the URLs will be added.	3
URLs	Required	The URL(s) to be added to the URL Block List.	[ "https://xmr.pool.minergate.com/index.html" ]
Description	Optional	The short description for the URL(s) to be blocked.	URL to block
Expiration Time	Optional	The time when the block will expire. If not specified, the block won’t expire automatically.	2018-12-18 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

CODE

[
    {
        "id": ***,
        "list_id": ***,
        "url_id": ***,
        "response_id": null,
        "reverse_user_id": null,
        "hash_reputation_id": null,
        "user_id": null,
        "enabled": true,
        "deleted": false,
        "description": "URL to block",
        "expiration": "2018-12-18T19:08:56Z",
        "created_at": "2017-01-11T03:47:15Z",
        "updated_at": "2017-01-11T03:47:15Z",
        "url": {
            "created_at": "2017-01-11T03:47:15Z",
            "url": "https://xmr.pool.minergate.com/index.html",
            "id": ***,
            "resolution_state": 4,
            "ttl": 0,
            "updated_at": "2017-01-11T03:47:15Z"
        }
    }
]

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

{
      "ListIDs": [
          ***
      ],
      "MemberIDs": [
          ***
      ],
      "Descriptions": [
          "URL to block"
      ]
}

Result

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

SAMPLE DATA

CODE

No Sample Data

Error Handling

If the Return Data is Partially Successful or 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.	Block URLs 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 Proofpoint Threat Response 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: Name or service not known.

Error Sample Data

Block URLs failed.

Status Code: 400.

Message: Name or service not known.

Close Incidents

Closes the specified incident(s).

READER NOTE

The parameter Incident IDs is required to run this command.

Run the Fetch Event command to obtain Incident IDs. Incident IDs can be found in the raw data at the path $[*].id.

Input

Input Parameter	Required/Optional	Description	Example
Incident IDs	Required	The ID(s) of incident(s) to be closed. Incident IDs can be obtained using the Fetch Event command.	[ *** ]
Summary	Required	The closure summary for the incident(s).	Closing incident
Details	Required	The closure details for the incident(s).	Message has been quarantined and user has been notified.

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

CODE

[
    {
        "incident_id": ***,
        "message": "The incident is closed successfully."
    }
]

Result

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

SAMPLE DATA

CODE

No Sample Data

Error Handling

If the Return Data is Partially Successful or 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.	Close Incidents 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 Proofpoint Threat Response 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: Name or service not known.

Error Sample Data

Close Incidents failed.

Status Code: 400.

Message: Name or service not known.

Fetch Event

Retrieves a list of incidents with details based on the specified criteria.

Input

Input Parameter	Required/Optional	Description	Example
Start Time	Required	The start time of the time range to fetch the list of incidents with details, in UTC time.	2018-05-26 00:00
End Time	Optional	The end time of the time range to fetch the list of incidents with details, in UTC time. If not specified, the default value is the current time.	2018-05-27 00:00
Query Time Type	Optional	The time field used to ingest incidents can be either the incident's Created Time or Closed Time. If not specified, the default query time type is Created Time.	Closed Time
Incident State	Optional	The state of the incident(s) to ingest. If not specified, incidents with any state will be returned.	New
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}.	5

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.

SAMPLE DATA

CODE

Successful

Raw Data

The primary response data from the API request.

SAMPLE DATA

CODE

[
    {
        "id": 1,
        "type": "Malware",
        "summary": "Unsolicited Bulk Email",
        "description": "EvilScheme test message",
        "score": ***,
        "state": "Open",
        "created_at": "2018-05-26T21:07:17Z",
        "event_count": 3,
        "event_sources": [
            "Proofpoint TAP"
        ],
        "users": [
            "nbadguy"
        ],
        "assignee": "Unassigned",
        "team": "Unassigned",
        "hosts": {
            "attacker": [
                "1.1.1.1",
                "http://tapdemo.evilscheme.org/files/313532373336373133382e33.pdf"
            ],
            "forensics": [
                "http://tapdemo.evilscheme.org/files/313532373336373133382e33.pdf",
                "tapdemo.evilscheme.org"
            ]
        },
        "incident_field_values": [
            {
                "name": "Attack Vector",
                "value": "Email"
            },
            {
                "name": "Classification",
                "value": "Spam"
            },
            {
                "name": "Severity",
                "value": "Critical"
            }
        ],
        "events": [
            {
                "id": 3,
                "category": "malware",
                "severity": "Info",
                "source": "Proofpoint TAP",
                "threatname": "Infection.PDF.File.Exploit.CVE-2010-0188_LibTIFF.",
                "classified": false,
                "state": "Linked",
                "description": "Infection.PDF.File.Exploit.CVE-2010-0188_LibTIFF.",
                "attackDirection": "inbound",
                "received": "2018-05-26T21:07:17Z",
                "malwareName": "Infection.PDF.File.Exploit.CVE-2010-0188_LibTIFF."
            },
            {
                "id": ***,
                "category": "spam",
                "severity": "Critical",
                "source": "Proofpoint TAP",
                "threatname": "Unsolicited Bulk Email",
                "classified": false,
                "state": "Linked",
                "attackDirection": "inbound",
                "received": "2018-05-26T21:07:17Z"
            },
            {
                "id": ***,
                "category": "spam",
                "severity": "Critical",
                "source": "Proofpoint TAP",
                "threatname": "Unsolicited Bulk Email",
                "classified": false,
                "state": "Linked",
                "attackDirection": "inbound",
                "received": "2018-05-26T21:07:17Z"
            }
        ],
        "quarantine_results": [],
        "successful_quarantines": 0,
        "failed_quarantines": 0,
        "pending_quarantines": 0
    }
]

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

{
      "IncidentTypes": [
          "Malware"
      ],
      "IncidentIDs": [
          ***
      ],
      "Descriptions": [
          "EvilScheme test message"
      ],
      "Scores": [
          ***
      ],
      "States": [
          "Open"
      ]
}

Result

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

SAMPLE DATA

CODE

No Sample Data

Fetch Event Field Mapping

Fetch Event commands require event field mapping. Field mapping plays a key role for data normalization within the event pipeline. Field mapping converts the original data fields from the different providers to standardized D3 fields as defined by the D3 Model. Please refer to Event and Incident Intake Field Mapping for details.

To customize field mapping, click + Add Field and add the custom field of your choice. You can 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 Proofpoint Threat Response 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 incidents. The default event source has a “Main Event JSON Path” (i.e., $) 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: $

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 $. 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 $.id.

The pre-configured field mappings are detailed below:

Field Name	Source Field
Unique Event Key	.id
Start Time	.created_at
Event Type	.type
Description	.description
Summary	.summary
Status	.state
Score	.score
Source	.event_sources
Aggregated / Correlated Event count	.event_count
Username	.users
Assignee	.assignee
Team	.team
Attacker Hosts	.hosts.attacker
Forensics Hosts	.hosts.forensics
Attack Vector	.incident_field_values[?(@.name=='Attack Vector')].value
Classification	.incident_field_values[?(@.name=='Classification')].value
Severity	.incident_field_values[?(@.name=='Severity')].value
Abuse Disposition	.incident_field_values[?(@.name=='Abuse Disposition')].value
URL	.hosts.url
Sub Event	.events
Successful Quarantines	.successful_quarantines
Failed Quarantines	.failed_quarantines
Pending Quarantines	.pending_quarantines
Quarantined Message IDs	.quarantine_results[*].messageId
Quarantined Message Recipients	.quarantine_results[*].recipient
Quarantined Statuses	.quarantine_results[*].status

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 Proofpoint Threat Response 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: Name or service not known.

Error Sample Data

Fetch Event failed.

Status Code: 400.

Message: Name or service not known.

Get Alert Details

Retrieves alert metadata from Threat Response.

Input

Input Parameter	Required/Optional	Description	Example
Alert IDs	Required	The ID(s) of alert(s) to retrieve. Alert IDs can be obtained using the Fetch Event command.	[ 3 ]

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

CODE

[
    {
        "id": ***,
        "severity": "Info",
        "source": "Abuse Mailbox Monitor",
        "state": "Linked",
        "attackDirection": "inbound",
        "received": "2019-02-25T17:22:48Z",
        "emails": [
            {
                "sender": {
                    "email": "test@example.com"
                },
                "recipient": {
                    "email": "test@example.com"
                },
                "subject": "FW: Report me!",
                "messageId": "<******>",
                "body": "<html dir=\"ltr\">DELETED</html>",
                "bodyType": "html",
                "headers": {
                    "Thread-Index": "******",
                    "Received": "from ORION-EXCH.orion.local ([::1]) by orion-exch.orion.local ([::1]) with mapi id 14.03.0123.003; Mon, 25 Feb 2019 09:21:59 -0800",
                    "X-MS-TNEF-Correlator": "<******>",
                    "Thread-Topic": "Report me!",
                    "Message-ID": "<******>",
                    "Content-Transfer-Encoding": "binary",
                    "X-MS-Exchange-Organization-AuthAs": "Internal",
                    "In-Reply-To": "<******>",
                    "X-MS-Exchange-Organization-AuthSource": "orion-exch.orion.local",
                    "Subject": "FW: Report me!",
                    "MIME-Version": "1.0",
                    "Date": "Mon, 25 Feb 2019 09:21:58 -0800",
                    "X-MS-Exchange-Organization-AuthMechanism": "04",
                    "X-MS-Exchange-Organization-SCL": "-1",
                    "References": "<******>,<******>,<******>",
                    "X-Originating-IP": "[1.1.1.1]",
                    "Accept-Language": "en-US",
                    "X-MS-Has-Attach": "yes",
                    "Content-Language": "en-US",
                    "Content-Type": "application/ms-tnef",
                    "X-PhishAlarm-Clear-Id": "******",
                    "X-PhishAlarm-Clear-Timeout": 45,
                    "X-PhishAlarm-Format": "PhishAlarm for Gmail; MethodOfDetermination=\"Guessing\"",
                    "X-PhishAlarm-Overcast-Trace-Token": "******",
                    "X-PhishAlarm-Reporter": "******",
                    "X-PhishAlarm-SES-key": "******"
                },
                "urls": [
                    "http://www.google.com"
                ],
                "attachments": [
                    {
                        "timestamp": "2019-01-28T09:43:87Z",
                        "safename": "******.pdf",
                        "realnamePII": {
                            "secret": "******.pdf"
                        },
                        "size": ******,
                        "contentType": "application/pdf",
                        "md5": "******",
                        "sha256": "******"
                    }
                ],
                "abuseCopy": true
            },
            {
                "sender": {
                    "email": "badguy@whatever.com"
                },
                "recipient": {
                    "email": "test@example.com"
                },
                "subject": "FW: Report me!",
                "messageId": "<******>",
                "body": "<html dir=\"ltr\">removed</html>",
                "bodyType": "html",
                "headers": {
                    "Thread-Index": "******",
                    "Received": "from ORION-EXCH.orion.local ([::1]) by orion-exch.orion.local ([::1]) with mapi id 14.03.0123.003; Mon, 25 Feb 2019 09:21:59 -0800",
                    "X-MS-TNEF-Correlator": "<******>",
                    "Thread-Topic": "Report me!",
                    "Message-ID": "<******>",
                    "Content-Transfer-Encoding": "binary",
                    "X-MS-Exchange-Organization-AuthAs": "Internal",
                    "In-Reply-To": "<******>",
                    "X-MS-Exchange-Organization-AuthSource": "orion-exch.orion.local",
                    "Subject": "FW: Report me!",
                    "MIME-Version": "1.0",
                    "Date": "Mon, 25 Feb 2019 09:21:58 -0800",
                    "X-MS-Exchange-Organization-AuthMechanism": "04",
                    "X-MS-Exchange-Organization-SCL": "-1",
                    "References": "<******>,<******>,<******>",
                    "X-Originating-IP": "[1.1.1.1]",
                    "Accept-Language": "en-US",
                    "X-MS-Has-Attach": "yes",
                    "Content-Language": "en-US",
                    "Content-Type": "application/ms-tnef"
                },
                "urls": [
                    "http://www.google.com"
                ],
                "attachments": [
                    {
                        "timestamp": "2019-01-28T09:43:87Z",
                        "safename": "******.pdf",
                        "realnamePII": {
                            "secret": "******.pdf"
                        },
                        "size": ******,
                        "contentType": "application/pdf",
                        "md5": "******",
                        "sha256": "******"
                    }
                ],
                "mimeContent": "removed",
                "abuseCopy": false
            }
        ]
    }
]

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

{
      "AlertIDs": [
          ***
      ],
      "Severities": [
          "Info"
      ],
      "Sources": [
          "Abuse Mailbox Monitor"
      ],
      "ReceivedTime": [
          "2019-02-25T17:22:48Z"
      ],
      "State": [
          "Linked"
      ],
      "AttackDirection": [
          "inbound"
      ]
}

Result

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

SAMPLE DATA

CODE

No Sample Data

Error Handling

If the Return Data is Partially Successful or 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 Alert Details 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 Proofpoint Threat Response 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: Name or service not known.

Error Sample Data

Get Alert Details failed.

Status Code: 400.

Message: Name or service not known.

Get Investigation Details

Retrieves investigation metadata from Threat Response.

Input

Input Parameter	Required/Optional	Description	Example
Investigation IDs	Required	The ID(s) of investigation(s) to retrieve.	[ *** ]

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

CODE

[
    {
        "id": ***,
        "created_at": "2021-01-08T17:20:07Z",
        "updated_at": "2021-03-11T05:49:15Z",
        "name": "test",
        "assignee": "System Administrator",
        "team": "Script Admins",
        "description": "asdadad",
        "investigation_field_values": [
            {
                "name": "Classification",
                "value": "Malware"
            },
            {
                "name": "Severity",
                "value": "Informational"
            },
            {
                "name": "Attack Vector",
                "value": "Email"
            },
            {
                "name": "IS-Unknown",
                "value": "False"
            }
        ],
        "incident_ids": [
            ***,
            ***
        ],
        "incidents": []
    }
]

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

{
      "InvestigationIDs": [
          ******
      ],
      "InvestigationNames": [
          "test"
      ],
      "Assignees": [
          "System Administrator"
      ],
      "CreatedTime": [
          "2021-01-08T17:20:07Z"
      ],
      "UpdatedTime": [
          "2021-03-11T05:49:15Z"
      ],
      "Descriptions": [
          "asdadad"
      ]
}

Result

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

SAMPLE DATA

CODE

No Sample Data

Error Handling

If the Return Data is Partially Successful or 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 Investigation Details 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 Proofpoint Threat Response 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: Name or service not known.

Error Sample Data

Get Investigation Details failed.

Status Code: 400.

Message: Name or service not known.

Get List Members

Retrieves all the members of the specified Threat Response list(s). The list can be a host list, URL list, user list, or file list.

READER NOTE

The parameter List IDs is required to run this command.

Please refer to the step below to get the List ID from UI:
- Login to Proofpoint Threat Response.
- Navigate to the Lists page and go to the sub-tab corresponding to the list you are searching for.
- Click on the desired list to display the list details.
- Review the URL in your browser’s address bar; the ID will be at the end of the URL.

Input

Input Parameter	Required/Optional	Description	Example
List IDs	Required	The ID(s) of the list(s) to retrieve members.	[ *** ]

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

CODE

[
    {
        "id": ***,
        "list_id": ****,
        "host_id": ***,
        "response_id": null,
        "reverse_user_id": null,
        "hash_reputation_id": null,
        "user_id": null,
        "enabled": true,
        "deleted": false,
        "description": "IP to block",
        "expiration": "2018-12-18T19:08:56Z",
        "created_at": "2017-01-11T03:47:15Z",
        "updated_at": "2017-01-11T03:47:15Z",
        "host": {
            "created_at": "2017-01-11T03:47:15Z",
            "host": "1.1.1.1",
            "id": ***,
            "resolution_state": 4,
            "ttl": 0,
            "updated_at": "2017-01-11T03:47:15Z"
        }
    },
    {
        "id": ***,
        "list_id": ***,
        "host_id": ***,
        "response_id": null,
        "reverse_user_id": null,
        "hash_reputation_id": null,
        "user_id": null,
        "enabled": true,
        "deleted": false,
        "description": "test",
        "expiration": null,
        "created_at": "2017-01-11T03:43:54Z",
        "updated_at": "2017-01-11T03:43:54Z",
        "host": {
            "created_at": "2016-12-29T04:56:13Z",
            "host": "string",
            "id": ***,
            "resolution_state": 4,
            "ttl": 0,
            "updated_at": "2017-01-13T00:45:16Z"
        }
    }
]

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

{
    "ListIDs": [
        ***
    ],
    "MemberIDs": [
        ***
    ],
    "Descriptions": [
        "IP to block"
    ]
}

Result

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

SAMPLE DATA

CODE

No Sample Data

Error Handling

If the Return Data is Partially Successful or 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 List Members 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 Proofpoint Threat Response 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: Name or service not known.

Error Sample Data

Get List Members failed.

Status Code: 400.

Message: Name or service not known.

Update Incident Descriptions

Sets the description field of the specified incident(s) to a given value.

READER NOTE

The parameter Incident IDs is required to run this command.

Run the Fetch Event command to obtain Incident IDs. Incident IDs can be found in the raw data at the path $[*].id.

Input

Input Parameter	Required/Optional	Description	Example
Incident IDs	Required	The ID(s) of the incident(s) to update the description(s). Incident IDs can be obtained using the Fetch Event command.	[ ***]
Description	Required	The description to be updated onto the specified incident(s).	Handing off incident to threat research team
Overwrite	Optional	The option to append to or overwrite the existing incident description. If not specified, the new description will be appended to the existing description.	False

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

CODE

[
    {
        "incident_id": ***,
        "message": "Update description of the incident successfully."
    }
]

Result

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

SAMPLE DATA

CODE

No Sample Data

Error Handling

If the Return Data is Partially Successful or 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.	Update Incident Descriptions 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 Proofpoint Threat Response 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: Name or service not known.

Error Sample Data

Update Incident Descriptions failed.

Status Code: 400.

Message: Name or service not known.

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 Proofpoint Threat Response 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: Name or service not known.

Error Sample Data

Test Connection failed. Failed to check the connector.

Status Code: 400.

Message: Name or service not known.