Proofpoint Targeted Attack Protection

LAST UPDATED: 05/30/2024

Overview

The API allows integration with these solutions by giving administrators the ability to periodically download detailed information about several types of TAP events in a SIEM-compatible, vendor-neutral format. The limit of request calls is 1800 per 24 hrs.

D3 SOAR is providing REST operations to function with Proofpoint Targeted Attack Protection.

Proofpoint Targeted Attack Protection is available for use in:

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

Connection

To connect to Proofpoint Targeted Attack Protection from D3 SOAR, please follow this part to collect the required information below:

Parameter	Description	Example
Server URL	The url of Proofpoint TAP. The default value is https://tap-api-v2.proofpoint.com.	https://tap-api-v2.proofpoint.com
Service Principal	The service principal for authentication.	admin
Secret	The secret for authentication.	*******
API Version	The API Version of the integration.	v2

Configuring D3 SOAR to Work with Proofpoint Targeted Attack Protection

Log in to D3 SOAR.
Find the Proofpoint Targeted Attack Protection integration.
1. Navigate to Configuration on the top header menu.
2. Click on the Integration icon on the left sidebar.
3. Type Proofpoint Targeted Attack Protection 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 Targeted Attack Protection.
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 the Server URL. The default value is https://tap-api-v2.proofpoint.com.
  2. Input the Service Principal.
  3. Input the Secret.
  4. Input the API Version. The default value is v2.
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 Targeted Attack Protection 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 Targeted Attack Protection API, please refer to the Proofpoint Targeted Attack Protection API reference.

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.

Decode URLS

Decodes one or more URLs.

Input

Input Parameter	Required/Optional	Description	Example
URLs	Required	The encoded url list to be decoded.	["https://urldefense.proofpoint.com/v2/******", "https://urldefense.proofpoint.com/v1/****", "https://urldefense.com/v3/******" ]

Output

Return Data

Indicates one of the possible command execution states: Successful or Failed.

The Failed state can be triggered by any of the following errors:

A connection issue with the integration
The API returned an error message
No response from the API

You can view more details about an error in the Error tab.

Return Data can be passed down directly to a subsequent command or used to create conditional tasks in playbooks.

SAMPLE DATA

CODE

Successful

Raw Data

The primary response data from the API request.

SAMPLE DATA

CODE

{
    "urls": [
        {
            "encodedUrl": "https://urldefense.proofpoint.com/v2/********",
            "decodedUrl": "https://media.mnn.com/*********/********/*****.jpg",
            "messageGuid": "rI2********eQw",
            "clusterName": "acme********ted",
            "recipientEmail": "c****@acme.zz",
            "success": true
        },
        {
            "encodedUrl": "https://urldefense.proofpoint.com/v1/********",
            "decodedUrl": "http://www.bouncycastle.org/",
            "messageGuid": "gni********kja",
            "clusterName": "acme********ted",
            "recipientEmail": "d******@acme.zz",
            "success": true
        },
        {
            "encodedUrl": "https://urldefense.com/v3/********",
            "decodedUrl": "https://google.com:********",
            "messageGuid": "********",
            "clusterName": "acme********ted",
            "recipientEmail": "b******@acme.zz",
            "success": true
        }
    ]
}

Context Data

The data extracted from Raw Data converted into JSON format. Context Data may be identical to Raw Data in some cases.

D3 customizes the Context Data by extracting the $.url in API returned JSON.

It is recommended to refer to the Raw Data instead of Context Data, since it contains the complete API response data. D3 will deprecate Context Data in the future, and playbook tasks using Context Data will be replaced with Raw Data.

SAMPLE DATA

CODE

[
    {
        "encodedUrl": "https://urldefense.proofpoint.com/v2/********",
        "decodedUrl": "https://media.mnn.com/*********/********/*****.jpg",
        "messageGuid": "rI2********eQw",
        "clusterName": "acme********ted",
        "recipientEmail": "c****@acme.zz",
        "success": true
    },
    {
        "encodedUrl": "https://urldefense.proofpoint.com/v1/********",
        "decodedUrl": "http://www.bouncycastle.org/",
        "messageGuid": "gni********kja",
        "clusterName": "acme********ted",
        "recipientEmail": "d******@acme.zz",
        "success": true
    },
    {
        "encodedUrl": "https://urldefense.com/v3/********",
        "decodedUrl": "https://google.com:********",
        "messageGuid": "********",
        "clusterName": "acme********ted",
        "recipientEmail": "b******@acme.zz",
        "success": true
    }
]

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

{
    "DecodedUrls": [
        "https://media.mnn.com/*********/********/*****.jpg",
        "http://www.bouncycastle.org/",
        "https://google.com:********"
    ],
    "MessageGUIDs": [
        "rI2********eQw",
        "gni********kja",
        "********"
    ],
    "ClusterNames": [
        "acme********ted",
        "acme********ted",
        "acme********ted"
    ],
    "RecipientEmails": [
        "c****@acme.zz",
        "d******@acme.zz",
        "b******@acme.zz"
    ]
}

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 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.	Decode 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 Targeted Attack Protection portal. Refer to the SIEM API Standard Responses for details.	Status Code: 401.
Message	The raw data or captured key error message from the integration API server about the API request failure.	Message: Unauthorized.

Error Sample Data

Decode URLS failed.

Status Code: 401.

Message: Unauthorized

Fetch Event

Retrieves a list of events with details based on the specified criteria(s). All the retrieved events will be merged into events field, with a new key "eventType" for each event.

Input

Input Parameter	Required/Optional	Description	Example
Start Time	Required	The start time of the time range in UTC time. The maximum time into the past that can be queried is 7 days which means the Start Time parameter cannot be more than 7 days ago to now.	2023-01-05 00:00
End Time	Optional	The end time of the time range in UTC time.	2023-01-06 00:00
Number of Event(s) Fetched	Optional	The maximum number of events to fetch. If the value is 0, a negative number, nor not specified, the command will return all events within the defined time range.	20
Time Range Type	Required	The time range type for the input time. Available values are: Interval (Max 1H), Since Time (Until Now). Default value is Interval (Max 1H). When Interval (Max 1H) is selected and End Time is more than 1 hour after the Start time, then it will return the top recent number of events between the Start Time and Start Time + 1H. When Since Time (Until Now) is selected, then it will return the top recent number of events between Start Time and now.	Interval (Max 1H)
Threat Type	Required	The field specifies which threat type will be returned in the data. Available values are: All, URL, Attachment and Message Text. Default value is All.	All
Threat Status	Required	The field specifies which threat statuses will be returned in the data. Available values are: Active Cleared, Active, Cleared, and False Positive. Default value is Active Cleared	Active Cleared

Output

Return Data

Indicates one of the possible command execution states: Successful or Failed.

The Failed state can be triggered by any of the following errors:

A connection issue with the integration
The API returned an error message
No response from the API

You can view more details about an error in the Error tab.

Return Data can be passed down directly to a subsequent command or used to create conditional tasks in playbooks.

SAMPLE DATA

CODE

Successful

Raw Data

The primary response data from the API request.

SAMPLE DATA

CODE

{
    "events": [
        {
            "campaignId": "46e********1a7",
            "classification": "MALWARE",
            "clickIP": "192.0.2.1",
            "clickTime": "2016-06-24T19:17:44.000Z",
            "GUID": "b27********9ce",
            "id": "8c8********25a",
            "messageID": "8c6********a81",
            "recipient": "b****.w****@pharmtech.zz",
            "sender": "9fa********7fa@badguy.zz",
            "senderIP": "192.0.*.***",
            "threatID": "61f********f50",
            "threatTime": "2016-06-24T19:17:46.000Z",
            "threatURL": "https://threatinsight.proofpoint.com/#/*****************/61f********f50",
            "threatStatus": "active",
            "url": "http://badguy.zz/",
            "userAgent": "Mozilla/5.0(WindowsNT6.1;WOW64;rv:27.0)Gecko/20100101Firefox/27.0",
            "eventType": "clicksPermitted"
        },
        {
            "GUID": "c26********9ce",
            "QID": "r2F********109",
            "ccAddresses": [
                "b****.w****@university-of-education.zz"
            ],
            "clusterId": "ph*******_****ed",
            "completelyRewritten": "true",
            "fromAddress": "ba****@evil.zz",
            "headerCC": "\"Br*** W****\" <b****.w****@university-of-education.zz>",
            "headerFrom": "\"A. Ba****\" <ba****@evil.zz>",
            "headerReplyTo": null,
            "headerTo": "\"Cl*** K***\" <cl***.k***@pharmtech.zz>; \"Di**** Pr****\" <di****.pr***@pharmtech.zz>",
            "impostorScore": 0,
            "malwareScore": 100,
            "messageID": "20*********@evil.zz",
            "messageParts": [
                {
                    "contentType": "text/plain",
                    "disposition": "inline",
                    "filename": "text.txt",
                    "md5": "008********8e2",
                    "oContentType": "text/plain",
                    "sandboxStatus": "unsupported",
                    "sha256": "857*********281"
                },
                {
                    "contentType": "application/pdf",
                    "disposition": "attached",
                    "filename": "Invoice for *********.pdf",
                    "md5": "587********31f",
                    "oContentType": "application/pdf",
                    "sandboxStatus": "threat",
                    "sha256": "2fa********5ca"
                }
            ],
            "messageTime": "2016-06-24T21:18:38.000Z",
            "modulesRun": [
                "pdr",
                "sandbox",
                "spam",
                "urldefense"
            ],
            "phishScore": 46,
            "policyRoutes": [
                "default_inbound",
                "executives"
            ],
            "quarantineFolder": "Attachment Defense",
            "quarantineRule": "module.sandbox.threat",
            "recipient": [
                "cl***.k***@pharmtech.zz",
                "di****.p****@pharmtech.zz"
            ],
            "replyToAddress": null,
            "sender": "e99********210@evil.zz",
            "senderIP": "192.0.*.***",
            "spamScore": 4,
            "subject": "Please find a totally safe invoice attached.",
            "threatsInfoMap": [
                {
                    "campaignId": "46e********1a7",
                    "classification": "MALWARE",
                    "threat": "2fa********5ca",
                    "threatId": "2fa********5ca",
                    "threatStatus": "active",
                    "threatTime": "2016-06-24T21:18:38.000Z",
                    "threatType": "ATTACHMENT",
                    "threatUrl": "https://threatinsight.proofpoint.com/#/*****************/2fa********5ca"
                },
                {
                    "campaignId": "46e********1a7",
                    "classification": "MALWARE",
                    "threat": "badsite.zz",
                    "threatId": "3ba****************1aa",
                    "threatTime": "2016-06-24T21:18:07.000Z",
                    "threatType": "URL",
                    "threatUrl": "https://threatinsight.proofpoint.com/#/*****************/3ba****************1aa"
                }
            ],
            "toAddresses": [
                "cl***.k***@pharmtech.zz",
                "di****.p****@pharmtech.zz"
            ],
            "xmailer": "Spambot v2.5",
            "eventType": "messagesBlocked"
        }
    ],
    "queryEndTime": "2016-06-24T21:36:00Z"
}

Context Data

The data extracted from Raw Data converted into JSON format. Context Data may be identical to Raw Data in some cases.

D3 customizes the Context Data by extracting the data from path $.events in API returned JSON.

It is recommended to refer to the Raw Data instead of Context Data, since it contains the complete API response data. D3 will deprecate Context Data in the future, and playbook tasks using Context Data will be replaced with Raw Data.

SAMPLE DATA

CODE

[
    {
        "campaignId": "46e********1a7",
        "classification": "MALWARE",
        "clickIP": "192.0.2.1",
        "clickTime": "2016-06-24T19:17:44.000Z",
        "GUID": "b27********9ce",
        "id": "8c8********25a",
        "messageID": "8c6********a81",
        "recipient": "b****.w****@pharmtech.zz",
        "sender": "9fa********7fa@badguy.zz",
        "senderIP": "192.0.*.***",
        "threatID": "61f********f50",
        "threatTime": "2016-06-24T19:17:46.000Z",
        "threatURL": "https://threatinsight.proofpoint.com/#/*****************/61f********f50",
        "threatStatus": "active",
        "url": "http://badguy.zz/",
        "userAgent": "Mozilla/5.0(WindowsNT6.1;WOW64;rv:27.0)Gecko/20100101Firefox/27.0",
        "eventType": "clicksPermitted"
    },
    {
        "GUID": "c26********9ce",
        "QID": "r2F********109",
        "ccAddresses": [
            "b****.w****@university-of-education.zz"
        ],
        "clusterId": "ph*******_****ed",
        "completelyRewritten": "true",
        "fromAddress": "ba****@evil.zz",
        "headerCC": "\"Br*** W****\" <b****.w****@university-of-education.zz>",
        "headerFrom": "\"A. Ba****\" <ba****@evil.zz>",
        "headerReplyTo": null,
        "headerTo": "\"Cl*** K***\" <cl***.k***@pharmtech.zz>; \"Di**** Pr****\" <di****.p****@pharmtech.zz>",
        "impostorScore": 0,
        "malwareScore": 100,
        "messageID": "20*********@evil.zz",
        "messageParts": [
            {
                "contentType": "text/plain",
                "disposition": "inline",
                "filename": "text.txt",
                "md5": "008********8e2",
                "oContentType": "text/plain",
                "sandboxStatus": "unsupported",
                "sha256": "857*********281"
            },
            {
                "contentType": "application/pdf",
                "disposition": "attached",
                "filename": "Invoice for *********.pdf",
                "md5": "587********31f",
                "oContentType": "application/pdf",
                "sandboxStatus": "threat",
                "sha256": "2fa********5ca"
            }
        ],
        "messageTime": "2016-06-24T21:18:38.000Z",
        "modulesRun": [
            "pdr",
            "sandbox",
            "spam",
            "urldefense"
        ],
        "phishScore": 46,
        "policyRoutes": [
            "default_inbound",
            "executives"
        ],
        "quarantineFolder": "Attachment Defense",
        "quarantineRule": "module.sandbox.threat",
        "recipient": [
            "cl***.k***@pharmtech.zz",
            "di****.p****@pharmtech.zz"
        ],
        "replyToAddress": null,
        "sender": "e99********210@evil.zz",
        "senderIP": "192.0.*.***",
        "spamScore": 4,
        "subject": "Please find a totally safe invoice attached.",
        "threatsInfoMap": [
            {
                "campaignId": "46e********1a7",
                "classification": "MALWARE",
                "threat": "2fa********5ca",
                "threatId": "2fa********5ca",
                "threatStatus": "active",
                "threatTime": "2016-06-24T21:18:38.000Z",
                "threatType": "ATTACHMENT",
                "threatUrl": "https://threatinsight.proofpoint.com/#/*****************/2fa********5ca"
            },
            {
                "campaignId": "46e********1a7",
                "classification": "MALWARE",
                "threat": "badsite.zz",
                "threatId": "3ba****************1aa",
                "threatTime": "2016-06-24T21:18:07.000Z",
                "threatType": "URL",
                "threatUrl": "https://threatinsight.proofpoint.com/#/*****************/3ba****************1aa"
            }
        ],
        "toAddresses": [
            "cl***.k***@pharmtech.zz",
            "di****.p****@pharmtech.zz"
        ],
        "xmailer": "Spambot v2.5",
        "eventType": "messagesBlocked"
    }
]

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

{
    "EventTypes": [
        "clicksPermitted",
        "messagesBlocked"
    ],
    "GUIDs": [
        "b27********9ce",
        "c26********9ce"
    ],
    "MessageIDs": [
        "8c6********a81",
        "20*********@evil.zz"
    ],
    "Senders": [
        "9fa********7fa@badguy.zz",
        "e99********210@evil.zz"
    ],
    "Recipients": [
        "b****.w****@pharmtech.zz",
        "cl***.k***@pharmtech.zz,di****.p****@pharmtech.zz"
    ],
    "SenderIPs": [
        "192.0.*.***",
        "192.0.*.***"
    ]
}

Result

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

SAMPLE DATA

CODE

No Sample Data

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

The Proofpoint Targeted Attack Protection integration in D3 SOAR has some pre-configured field mappings for the Clicks Blocked Events, Messages Delivered Event and Messages Blocked Event, which correspond to the Clicks Blocked Events, Messages Delivered Event and Messages Blocked Event mappings:

Default Event Source
Configures the field mapping for the fields which are common for Clicks Blocked Events, Messages Delivered Event and Messages Blocked Event. The default event source has a “Main Event JSON Path” (i.e., $.events) 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: $.events
  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 events. The child node denoting the Event Type field would be eventType. Putting it together, the JSON Path expression to extract the Event Type is $.events.eventType.
Clicks Blocked Events

Configures the field mapping which are specific to the Clicks Blocked Events. If a source field in the field mapping is not found, the corresponding field mapping will be ignored. As the data of the Clicks Blocked Events have a character that the value of the eventType field is clicksBlocked, the Clicks Blocked Events can be defined by the Search String: {$.eventType} = clicksBlocked. Click Edit Event Source to view the Search String.

Note: The Clicks Blocked Events field mapping will be applied in addition to the Default Event Source field mapping for Clicks Blocked Events.

Messages Delivered Event

Configures the field mapping which are specific to the Messages Delivered Event. If a source field in the field mapping is not found, the corresponding field mapping will be ignored. As the data of the Messages Delivered Event have a character that the value of the eventType field is messagesDelivered, the Messages Delivered Event can be defined by the Search String: {$.eventType} = messagesDelivered. Click Edit Event Source to view the Search String.

Note: The Messages Delivered Event field mapping will be applied in addition to the Default Event Source field mapping for Messages Delivered Event.

Messages Blocked Event

Configures the field mapping which are specific to the Messages Blocked Event. If a source field in the field mapping is not found, the corresponding field mapping will be ignored. As the data of the Messages Blocked Event have a character that the value of the eventType field is messagesBlocked, the Messages Blocked Event can be defined by the Search String: {$.eventType} = messagesBlocked. Click Edit Event Source to view the Search String.

Note: The Messages Blocked Event field mapping will be applied in addition to the Default Event Source field mapping for Messages Blocked Event.

The pre-configured field mappings are detailed below:

Field Name	Source Field
Default Event Source (Main Event JSON Path: $.events)
Unique Event Key	.GUID
Event Type	.eventType
Start Time	.threatTime
Sender	.sender
Recipient	.recipient
Message ID	.messageID
Threat category	.classification
Click IP	.clickIP
Click Unique ID	.id
Campaign ID	.campaignId
Threat ID	.threatID
Threat Status	.threatStatus
Clicked URL	.url
Clicks Blocked Event (Search String: {$.eventType} = clicksBlocked) The search string format is {jsonpath}=value. If the value of the eventType key is clicksBlocked in the event object under raw data, then the Clicks Blocked Event will use the field mapping below.
Unique Event Key	.GUID
Event Type	.eventType
Start Time	.threatTime
Sender	.sender
Recipient	.recipient
Message ID	.messageID
Threat category	.classification
Click IP	.clickIP
Click Unique ID	.id
Campaign ID	.campaignId
Threat ID	.threatID
Threat Status	.threatStatus
Clicked URL	.url
Messages Delivered Event (Search String: {$.eventType} = messagesDelivered) The search string format is {jsonpath}=value. If the value of the eventType key is messagesDelivered in the event object under raw data, then the Messages Delivered Event will use the field mapping below.
Unique Event Key	.GUID
Event Type	.eventType
Start Time	.messageTime
Sender	.fromAddress
Recipient	.recipient
Message ID	.messageID
Email subject	.subject
Queue ID	.QID
Malware Score	.malwareScore
Spam Score	.spamScore
Messages Blocked Event (Search String: {$.eventType} = messagesBlocked) The search string format is {jsonpath}=value. If the value of the eventType key is messagesBlocked in the event object under raw data, then the Messages Blocked Event will use the field mapping below.
Unique Event Key	.GUID
Event Type	.eventType
Start Time	.messageTime
Sender	.fromAddress
Recipient	.recipient
Message ID	.messageID
Email subject	.subject
Queue ID	.QID
Malware Score	.malwareScore
Spam Score	.spamScore

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 Targeted Attack Protection portal. Refer to the SIEM API Standard Responses for details.	Status Code: 401.
Message	The raw data or captured key error message from the integration API server about the API request failure.	Message: Unauthorized.

Error Sample Data

Fetch Event failed.

Status Code: 401.

Message: Unauthorized.

Get Threat Details

The Threat API allows administrators to pull detailed attributes about individual threats observed in their environment. It can be used to retrieve more intelligence for threats identified in the SIEM or Campaign API responses.

READER NOTE

The parameter Threat IDs is required to run this command.

Run the Fetch Events command to obtain Threat IDs. Threat IDs can be found in the raw data at the path $.events[*].threatID.

Input

Input Parameter	Required/Optional	Description	Example
Threat IDs	Required	The IDs list of the threats to be used to retrieve the details. Threat IDs can be obtained using the Fetch Event command.	["029*******a6f", "c54******b9f"]

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

{
    "results": [
        {
            "id": "029*********a6f",
            "identifiedAt": "2020-07-21T15:30:10.000Z",
            "name": "029*********a6f",
            "type": "attachment",
            "category": "malware",
            "status": "active",
            "severity": 20,
            "attackSpread": 62,
            "notable": false,
            "verticals": false,
            "geographies": false,
            "actors": [
                {
                    "id": "6e3********3ba",
                    "name": "TA***"
                }
            ],
            "families": [
                {
                    "id": "cfd********1e0",
                    "name": "Ba***ng"
                }
            ],
            "malware": [
                {
                    "id": "8fa********25c",
                    "name": "Ur**if"
                }
            ],
            "techniques": [
                {
                    "id": "acc********85b",
                    "name": "XL* ****os"
                }
            ],
            "brands": [
                {
                    "id": "aca********85b",
                    "name": "Do****gn"
                }
            ]
        }
    ],
    "errors": []
}

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

{
    "ThreatIDs": [
        "029*********a6f",
        "c54********b9f"
    ],
    "Categories": [
        "malware",
        "malware"
    ]
}

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 Threat 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 Targeted Attack Protection portal. Refer to the SIEM API Standard Responses for details.	Status Code: 401.
Message	The raw data or captured key error message from the integration API server about the API request failure.	Message: Unauthorized.

Error Sample Data

Get Threat Details failed.

Status Code: 401.

Message: Unauthorized.

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.

Return Data can be passed down directly to a subsequent command or used to create conditional tasks in playbooks.

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 Targeted Attack Protection portal. Refer to the SIEM API Standard Responses for details.	Status Code: 401.
Message	The raw data or captured key error message from the integration API server about the API request failure.	Message: Unauthorized.

Error Sample Data

Test Connection failed. Failed to check the connector.

Status Code: 401.

Message: Unauthorized.