Skip to main content
Skip table of contents

Cofense Triage V2

LAST UPDATED: 03/19/2024

Overview

With Cofense Triage Phishing Detection and Response Center, clients can defend against phishing attacks while alleviating the burden on overwhelmed security teams. Integration with the Cofense Triage API Version 2 can help to programmatically create, extract, update, and delete data from Cofense Triage.

D3 SOAR is providing REST operations to function with Cofense Triage V2.

Cofense Triage V2 is available for use in:

D3 SOAR

V12.7.441+

Category

Threat Intelligence

Deployment Options

Option II, Option IV

Connection

To connect to Cofense Triage V2 from D3 SOAR, please follow this part to collect the required information below:

Parameter

Description

Example

Server URL

The URL of Cofense Triage server.

https://<client-instance>.phishmecloud.com

Client ID

The client ID for authentication.

AR*****X5_SA

Client Secret

The client secret for authentication.

Br*****b0s

API Version

The version of API.

v2

Configuring D3 SOAR to Work with Cofense Triage V2

  1. Log in to D3 SOAR.

  2. Find the Cofense Triage V2 integration.

a. Navigate to Configuration on the top header menu.

b. Click on the Integration icon on the left sidebar.

c. Type Cofense Triage V2 in the search box to find the integration, then click it to select it.

d. Click + Connection, on the right side of the Connections section. A new connection window will appear.

  1. Configure the following fields to create a connection to Cofense Triage V2.

a. Connection Name: The desired name for the connection.

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

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

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

e. Description (Optional): Add your desired description for the connection.

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

g. Configure User Permissions: Defines which users have access to the connection.

h. Active: Check the tick box to ensure the connection is available for use.

i . 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://<client-instance>.phishmecloud.com.

2. Copy the Client ID from the Cofense Triage V2 platform.

3. Copy the Client Secret from the Cofense Triage V2 platform.

4. Input the API Version. The default value is v2.

j. 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.
k. 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 tick box. 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.

  1. Test the connection.

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

b. Click OK to close the alert window.

c. Click + Add to create and add the configured connection.

Commands

Cofense Triage V2 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 Cofense Triage V2 API, please refer to the Cofense Triage V2 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:

  1. Navigate to Configuration > Application Settings. Select Date/Time Format.

  2. Choose your desired date and time format.

After that, you will be able to view your preferred time format when configuring the DateTime input parameters for commands.

Add Comment

Creates comments to resources.

READER NOTE

Resource ID is a required parameter to run this command.

  • If the Resource Type = Reports, the resource ID can be obtained from the Fetch Event command. Report IDs can be found in the returned raw data at the path $.data[*].id.

  • If the Resource Type = Threat Indicators, the resource ID can be obtained from the List Threat Indicators command. Threat Indicators can be found in the returned raw data at the path $.data[*].id.

Input

Input Parameter

Required/Optional

Description

Example

ResourceType

Required

The type of the resource. Available options are Reports and Threat Indicators.

Reports

Resource ID

Required

The ID of the resource to which the comment is being added.

*****

Comment

Required

The comment to be added.

Test Comment

Output

Raw Data

The primary response data from the API request.

SAMPLE DATA

CODE
{
    "data": {
        "id": "*****",
        "type": "comments",
        "links": {
            "self": "https://*****.phishmecloud.com/api/*****"
        },
        "attributes": {
            "body_format": "text",
            "body": "Is this malicious or just delicious?",
            "tags": [],
            "created_at": "2021-08-31T22:53:21.050Z",
            "updated_at": "2021-08-31T22:53:21.050Z"
        },
        "relationships": {
            "commentable": {
                "links": {
                    "self": "https://*****.phishmecloud.com/api/*****",
                    "related": "https://*****.phishmecloud.com/api/*****"
                },
                "data": {
                    "type": "reports",
                    "id": "*****"
                }
            },
            "owner": {
                "links": {
                    "self": "https://*****.phishmecloud.com/api/*****",
                    "related": "https://*****.phishmecloud.com/api/*****"
                },
                "data": {
                    "type": "api_applications",
                    "id": "*****"
                }
            }
        }
    }
}
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
{
  "CommentID": *****,
  "CreatedAt": "2021-08-31T22:53:21.050Z"
}
Return Data

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

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

  • A connection issue with the integration

  • The API returned an error message

  • No response from the API

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

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

SAMPLE DATA

CODE
Successful
Result

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

SAMPLE DATA

data

{'id': '*****', 'type': 'comments', 'links': {'self': 'https://*****.phishmecloud.com/api/*****'}, 'attributes': {'body_format': 'text', 'body': 'Is this malicious or just delicious?', 'tags': [], 'created_at': '2021-08-31T22:53:21.050Z', 'updated_at': '2021-08-31T22:53:21.050Z'}, 'relationships': {'commentable': {'links': {'self': 'https://*****.phishmecloud.com/api/*****', 'related': 'https://*****.phishmecloud.com/api/*****'}, 'data': {'type': 'reports', 'id': '*****'}}, 'owner': {'links': {'self': 'https://*****.phishmecloud.com/api/*****', 'related': 'https://*****.phishmecloud.com/api/*****'}, 'data': {'type': 'api_applications', 'id': '19'}}}}

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.

Add Comment 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 Cofense Triage V2 portal. Refer to the HTTP Status Code Registry for details.

Status Code: 404.

Message

The raw data or captured key error message from the integration API server about the API request failure.

Message: The requested resource does not exist.

Error Sample Data

Add Comment failed.

Status CoThe requested resource does not exist.

Categorize Report

Categorizes reports.

READER NOTE

The parameter Report IDs is required to run this command.

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

Input

Input Parameter

Required/Optional

Description

Example

Report IDs

Required

The report IDs to be categorized. Report ID can be obtained using the Fetch Event command.

[ "*****" ]

Category Name

Required

The name of the category.

Crimeware

Output

Raw Data

The primary response data from the API request.

SAMPLE DATA

CODE
[
    {
        "data": {
            "id": "*****",
            "type": "reports",
            "links": {
                "self": "https://*****.phishmecloud.com/api/*****"
            },
            "attributes": {
                "location": "Processed",
                "risk_score": 95,
                "from_address": null,
                "subject": "***** - Click this link, or else!",
                "received_at": "2021-01-08T20:27:21.000Z",
                "reported_at": "2021-01-08T20:27:20.000Z",
                "raw_headers": "Date: Fri, 08 Jan 2021 20:28:05 +0000\r\nMessage-ID: <*****@*****>\r\nSubject: ***** - Click this link, or else!\r\nMime-Version: 1.0\r\nContent-Type: multipart/mixed;\r\n boundary=\"--==_mimepart_*****\";\r\n charset=UTF-8\r\nContent-Transfer-Encoding: 7bit",
                "text_body": "Please click on this URL<https://www.*****.com/*****.html> in order to keep your account active. Failure to do so will result in immediate termination of our services.\r\n\r\n[*****+*****=]\r\n\r\n\r\nThank you,\r\n-Customer Service\r\n\r\n\r\n",
                "html_body": "<html xmlns:v=\"urn:schemas-microsoft-com:vml\" xmlns:o=\"urn:schemas-microsoft-com:office:office\" xmlns:w=\"urn:schemas-microsoft-com:office:word\" xmlns:x=\"urn:schemas-microsoft-com:office:excel\" xmlns:m=\"http://*****.com/*****\" xmlns=\"http://*****.org/*****\">\r\n<head>\r\n<meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\">\r\n<meta name=\"Generator\" content=\"Microsoft Word 15 (filtered medium)\">\r\n<!--[if !mso]><style>v\\:* {behavior:url(#default#VML);}\r\no\\:* {behavior:url(#default#VML);}\r\nw\\:* {behavior:url(#default#VML);}\r\n.shape {behavior:url(#default#VML);}\r\n</style><![endif]--><style><!--\r\n/* Font Definitions */\r\n@font-face\r\n\t{font-family:Wingdings;\r\n\tpanose-1:5 0 0 0 0 0 0 0 0 0;}\r\n@font-face\r\n\t{font-family:\"Cambria Math\";\r\n\tpanose-1:2 4 5 3 5 4 6 3 2 4;}\r\n@font-face\r\n\t{font-family:Calibri;\r\n\tpanose-1:2 15 5 2 2 2 4 3 2 4;}\r\n/* Style Definitions */\r\np.MsoNormal, li.MsoNormal, div.MsoNormal\r\n\t{margin:0in;\r\n\tfont-size:12.0pt;\r\n\tfont-family:\"Calibri\",sans-serif;}\r\na:link, span.MsoHyperlink\r\n\t{mso-style-priority:99;\r\n\tcolor:#0563C1;\r\n\ttext-decoration:underline;}\r\nspan.EmailStyle17\r\n\t{mso-style-type:personal-compose;\r\n\tfont-family:\"Calibri\",sans-serif;\r\n\tcolor:windowtext;}\r\n.MsoChpDefault\r\n\t{mso-style-type:export-only;\r\n\tfont-size:12.0pt;\r\n\tfont-family:\"Calibri\",sans-serif;}\r\n@page WordSection1\r\n\t{size:8.5in 11.0in;\r\n\tmargin:1.0in 1.0in 1.0in 1.0in;}\r\ndiv.WordSection1\r\n\t{page:WordSection1;}\r\n/* List Definitions */\r\n@list l0\r\n\t{mso-list-id:1672101899;\r\n\tmso-list-type:hybrid;\r\n\tmso-list-template-ids:***** ***** ***** ***** ***** ***** ***** ***** ***** *****;}\r\n@list l0:level1\r\n\t{mso-level-number-format:bullet;\r\n\tmso-level-text:-;\r\n\tmso-level-tab-stop:none;\r\n\tmso-level-number-position:left;\r\n\ttext-indent:-.25in;\r\n\tfont-family:\"Calibri\",sans-serif;\r\n\tmso-fareast-font-family:Calibri;}\r\n@list l0:level2\r\n\t{mso-level-number-format:bullet;\r\n\tmso-level-text:o;\r\n\tmso-level-tab-stop:none;\r\n\tmso-level-number-position:left;\r\n\ttext-indent:-.25in;\r\n\tfont-family:\"Courier New\";}\r\n@list l0:level3\r\n\t{mso-level-number-format:bullet;\r\n\tmso-level-text:;\r\n\tmso-level-tab-stop:none;\r\n\tmso-level-number-position:left;\r\n\ttext-indent:-.25in;\r\n\tfont-family:Wingdings;}\r\n@list l0:level4\r\n\t{mso-level-number-format:bullet;\r\n\tmso-level-text:;\r\n\tmso-level-tab-stop:none;\r\n\tmso-level-number-position:left;\r\n\ttext-indent:-.25in;\r\n\tfont-family:Symbol;}\r\n@list l0:level5\r\n\t{mso-level-number-format:bullet;\r\n\tmso-level-text:o;\r\n\tmso-level-tab-stop:none;\r\n\tmso-level-number-position:left;\r\n\ttext-indent:-.25in;\r\n\tfont-family:\"Courier New\";}\r\n@list l0:level6\r\n\t{mso-level-number-format:bullet;\r\n\tmso-level-text:;\r\n\tmso-level-tab-stop:none;\r\n\tmso-level-number-position:left;\r\n\ttext-indent:-.25in;\r\n\tfont-family:Wingdings;}\r\n@list l0:level7\r\n\t{mso-level-number-format:bullet;\r\n\tmso-level-text:;\r\n\tmso-level-tab-stop:none;\r\n\tmso-level-number-position:left;\r\n\ttext-indent:-.25in;\r\n\tfont-family:Symbol;}\r\n@list l0:level8\r\n\t{mso-level-number-format:bullet;\r\n\tmso-level-text:o;\r\n\tmso-level-tab-stop:none;\r\n\tmso-level-number-position:left;\r\n\ttext-indent:-.25in;\r\n\tfont-family:\"Courier New\";}\r\n@list l0:level9\r\n\t{mso-level-number-format:bullet;\r\n\tmso-level-text:;\r\n\tmso-level-tab-stop:none;\r\n\tmso-level-number-position:left;\r\n\ttext-indent:-.25in;\r\n\tfont-family:Wingdings;}\r\nol\r\n\t{margin-bottom:0in;}\r\nul\r\n\t{margin-bottom:0in;}\r\n--></style><!--[if gte mso 9]><xml>\r\n<o:shapedefaults v:ext=\"edit\" spidmax=\"1026\" />\r\n</xml><![endif]--><!--[if gte mso 9]><xml>\r\n<o:shapelayout v:ext=\"edit\">\r\n<o:idmap v:ext=\"edit\" data=\"1\" />\r\n</o:shapelayout></xml><![endif]-->\r\n</head>\r\n<body lang=\"EN-US\" link=\"#0563C1\" vlink=\"#9*****F72\" style=\"word-wrap:break-word\">\r\n<div class=\"WordSection1\">\r\n<p class=\"MsoNormal\"><span style=\"font-size:11.0pt\">Please click on this <a href=\"https://www.*****.com/*****.html\">\r\nURL</a> in order to keep your account active. Failure to do so will result in immediate termination of our services.<o:p></o:p></span></p>\r\n<p class=\"MsoNormal\"><span style=\"font-size:11.0pt\"><o:p>&nbsp;</o:p></span></p>\r\n<p class=\"MsoNormal\"><span style=\"font-size:11.0pt\"><img border=\"0\" width=\"150\" height=\"150\" style=\"width:1.5625in;height:1.5625in\" id=\"Picture_x0020_7\" src=\"cid:image001.png@01D6E5D2.C0BEA220\" alt=\"*****+*****=\"></span><span style=\"font-size:11.0pt\"><o:p></o:p></span></p>\r\n<p class=\"MsoNormal\"><span style=\"font-size:11.0pt\"><o:p>&nbsp;</o:p></span></p>\r\n<p class=\"MsoNormal\"><span style=\"font-size:11.0pt\"><o:p>&nbsp;</o:p></span></p>\r\n<p class=\"MsoNormal\"><span style=\"font-size:11.0pt\">Thank you,<o:p></o:p></span></p>\r\n<p class=\"MsoNormal\"><span style=\"font-size:11.0pt\">-Customer Service<o:p></o:p></span></p>\r\n<p class=\"MsoNormal\"><span style=\"font-size:11.0pt\"><o:p>&nbsp;</o:p></span></p>\r\n<p class=\"MsoNormal\"><span style=\"font-size:11.0pt\"><o:p>&nbsp;</o:p></span></p>\r\n</div>\r\n</body>\r\n</html>\r\n",
                "md5": "*****",
                "sha256": "*****",
                "match_priority": 2,
                "attachments_count": 1,
                "comments_count": 0,
                "rules_count": 1,
                "urls_count": 1,
                "tags": [
                    "999",
                    "888"
                ],
                "categorization_tags": [
                    "three1",
                    "two",
                    "one"
                ],
                "processed_at": "2021-08-31T20:10:39.487Z",
                "created_at": "2021-01-08T20:28:05.372Z",
                "updated_at": "2021-08-31T20:08:52.*****2Z"
            },
            "relationships": {
                "assignee": {
                    "links": {
                        "self": "https://*****.phishmecloud.com/api/*****",
                        "related": "https://*****.phishmecloud.com/api/*****"
                    },
                    "data": null
                },
                "category": {
                    "links": {
                        "self": "https://*****.phishmecloud.com/api/*****",
                        "related": "https://*****.phishmecloud.com/api/*****"
                    },
                    "data": {
                        "type": "categories",
                        "id": "*****"
                    }
                },
                "cluster": {
                    "links": {
                        "self": "https://*****.phishmecloud.com/api/*****",
                        "related": "https://*****.phishmecloud.com/api/*****"
                    },
                    "data": {
                        "type": "clusters",
                        "id": "*****"
                    }
                },
                "reporter": {
                    "links": {
                        "self": "https://*****.phishmecloud.com/api/*****",
                        "related": "https://*****.phishmecloud.com/api/*****"
                    },
                    "data": {
                        "type": "reporters",
                        "id": "*****"
                    }
                },
                "attachment_payloads": {
                    "links": {
                        "self": "https://*****.phishmecloud.com/api/*****",
                        "related": "https://*****.phishmecloud.com/api/*****"
                    }
                },
                "attachments": {
                    "links": {
                        "self": "https://*****.phishmecloud.com/api/*****",
                        "related": "https://*****.phishmecloud.com/api/*****"
                    }
                },
                "domains": {
                    "links": {
                        "self": "https://*****.phishmecloud.com/api/*****",
                        "related": "https://*****.phishmecloud.com/api/*****"
                    }
                },
                "headers": {
                    "links": {
                        "self": "https://*****.phishmecloud.com/api/*****",
                        "related": "https://*****.phishmecloud.com/api/*****"
                    }
                },
                "hostnames": {
                    "links": {
                        "self": "https://*****.phishmecloud.com/api/*****",
                        "related": "https://*****.phishmecloud.com/api/*****"
                    }
                },
                "urls": {
                    "links": {
                        "self": "https://*****.phishmecloud.com/api/*****",
                        "related": "https://*****.phishmecloud.com/api/*****"
                    }
                },
                "rules": {
                    "links": {
                        "self": "https://*****.phishmecloud.com/api/*****",
                        "related": "https://*****.phishmecloud.com/api/*****"
                    }
                },
                "threat_indicators": {
                    "links": {
                        "self": "https://*****.phishmecloud.com/api/*****",
                        "related": "https://*****.phishmecloud.com/api/*****"
                    }
                },
                "comments": {
                    "links": {
                        "self": "https://*****.phishmecloud.com/api/*****",
                        "related": "https://*****.phishmecloud.com/api/*****"
                    }
                }
            },
            "meta": {
                "risk_score_summary": {
                    "integrations": 75,
                    "vip": 5,
                    "reporter": 15,
                    "rules": 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
{
  "IDs": ["*****"],
  "CategoryIDs": ["***"],
  "ProcessedAt": ["2021-08-31T20:10:39.487Z"]
}
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
Result

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

SAMPLE DATA

data

{'id': '*****', 'type': 'reports', 'links': {'self': 'https://*****.phishmecloud.com/api/*****'}, 'attributes': {'location': 'Processed', 'risk_score': 95, 'from_address': None, 'subject': '***** - Click this link, or else!', 'received_at': '2021-01-08T20:27:21.000Z', 'reported_at': '2021-01-08T20:27:20.000Z', 'raw_headers': 'Date: Fri, 08 Jan 2021 20:28:05 +0000\r\nMessage-ID: <*****@*****>\r\nSubject: ***** - Click this link, or else!\r\nMime-Version: 1.0\r\nContent-Type: multipart/mixed;\r\n boundary="--==_mimepart_*****";\r\n charset=UTF-8\r\nContent-Transfer-Encoding: 7bit', 'text_body': 'Please click on this URL<https://www.*****.com/*****.html> in order to keep your account active. Failure to do so will result in immediate termination of our services.\r\n\r\n[*****+*****=]\r\n\r\n\r\nThank you,\r\n-Customer Service\r\n\r\n\r\n', 'html_body': '<html xmlns:v="urn:schemas-microsoft-com:vml" xmlns:o="urn:schemas-microsoft-com:office:office" xmlns:w="urn:schemas-microsoft-com:office:word" xmlns:x="urn:schemas-microsoft-com:office:excel" xmlns:m="http://*****.com/*****" xmlns="http://www.w3.org/TR/REC-html40 ">\r\n<head>\r\n<meta http-equiv="Content-Type" content="text/html; charset=utf-8">\r\n<meta name="Generator" content="Microsoft Word 15 (filtered medium)">\r\n<!--[if !mso]><style>v\\:* {behavior:url(#default#VML);}\r\no\\:* {behavior:url(#default#VML);}\r\nw\\:* {behavior:url(#default#VML);}\r\n.shape {behavior:url(#default#VML);}\r\n</style><![endif]--><style><!--\r\n/* Font Definitions */\r\n@font-face\r\n\t{font-family:Wingdings;\r\n\tpanose-1:5 0 0 0 0 0 0 0 0 0;}\r\n@font-face\r\n\t{font-family:"Cambria Math";\r\n\tpanose-1:2 4 5 3 5 4 6 3 2 4;}\r\n@font-face\r\n\t{font-family:Calibri;\r\n\tpanose-1:2 15 5 2 2 2 4 3 2 4;}\r\n/* Style Definitions */\r\np.MsoNormal, li.MsoNormal, div.MsoNormal\r\n\t{margin:0in;\r\n\tfont-size:12.0pt;\r\n\tfont-family:"Calibri",sans-serif;}\r\na:link, span.MsoHyperlink\r\n\t{mso-style-priority:99;\r\n\tcolor:#0563C1;\r\n\ttext-decoration:underline;}\r\nspan.EmailStyle17\r\n\t{mso-style-type:personal-compose;\r\n\tfont-family:"Calibri",sans-serif;\r\n\tcolor:windowtext;}\r\n.MsoChpDefault\r\n\t{mso-style-type:export-only;\r\n\tfont-size:12.0pt;\r\n\tfont-family:"Calibri",sans-serif;}\r\n@page WordSection1\r\n\t{size:8.5in 11.0in;\r\n\tmargin:1.0in 1.0in 1.0in 1.0in;}\r\ndiv.WordSection1\r\n\t{page:WordSection1;}\r\n/* List Definitions */\r\n@list l0\r\n\t{mso-list-id:1672101899;\r\n\tmso-list-type:hybrid;\r\n\tmso-list-template-ids:***** ***** ***** ***** ***** ***** ***** ***** ***** *****;}\r\n@list l0:level1\r\n\t{mso-level-number-format:bullet;\r\n\tmso-level-text:-;\r\n\tmso-level-tab-stop:none;\r\n\tmso-level-number-position:left;\r\n\ttext-indent:-.25in;\r\n\tfont-family:"Calibri",sans-serif;\r\n\tmso-fareast-font-family:Calibri;}\r\n@list l0:level2\r\n\t{mso-level-number-format:bullet;\r\n\tmso-level-text:o;\r\n\tmso-level-tab-stop:none;\r\n\tmso-level-number-position:left;\r\n\ttext-indent:-.25in;\r\n\tfont-family:"Courier New";}\r\n@list l0:level3\r\n\t{mso-level-number-format:bullet;\r\n\tmso-level-text:\uf0a7;\r\n\tmso-level-tab-stop:none;\r\n\tmso-level-number-position:left;\r\n\ttext-indent:-.25in;\r\n\tfont-family:Wingdings;}\r\n@list l0:level4\r\n\t{mso-level-number-format:bullet;\r\n\tmso-level-text:\uf0b7;\r\n\tmso-level-tab-stop:none;\r\n\tmso-level-number-position:left;\r\n\ttext-indent:-.25in;\r\n\tfont-family:Symbol;}\r\n@list l0:level5\r\n\t{mso-level-number-format:bullet;\r\n\tmso-level-text:o;\r\n\tmso-level-tab-stop:none;\r\n\tmso-level-number-position:left;\r\n\ttext-indent:-.25in;\r\n\tfont-family:"Courier New";}\r\n@list l0:level6\r\n\t{mso-level-number-format:bullet;\r\n\tmso-level-text:\uf0a7;\r\n\tmso-level-tab-stop:none;\r\n\tmso-level-number-position:left;\r\n\ttext-indent:-.25in;\r\n\tfont-family:Wingdings;}\r\n@list l0:level7\r\n\t{mso-level-number-format:bullet;\r\n\tmso-level-text:\uf0b7;\r\n\tmso-level-tab-stop:none;\r\n\tmso-level-number-position:left;\r\n\ttext-indent:-.25in;\r\n\tfont-family:Symbol;}\r\n@list l0:level8\r\n\t{mso-level-number-format:bullet;\r\n\tmso-level-text:o;\r\n\tmso-level-tab-stop:none;\r\n\tmso-level-number-position:left;\r\n\ttext-indent:-.25in;\r\n\tfont-family:"Courier New";}\r\n@list l0:level9\r\n\t{mso-level-number-format:bullet;\r\n\tmso-level-text:\uf0a7;\r\n\tmso-level-tab-stop:none;\r\n\tmso-level-number-position:left;\r\n\ttext-indent:-.25in;\r\n\tfont-family:Wingdings;}\r\nol\r\n\t{margin-bottom:0in;}\r\nul\r\n\t{margin-bottom:0in;}\r\n--></style><!--[if gte mso 9]><xml>\r\n<o:shapedefaults v:ext="edit" spidmax="1026" />\r\n</xml><![endif]--><!--[if gte mso 9]><xml>\r\n<o:shapelayout v:ext="edit">\r\n<o:idmap v:ext="edit" data="1" />\r\n</o:shapelayout></xml><![endif]-->\r\n</head>\r\n<body lang="EN-US" link="#0563C1" vlink="#9*****F72" style="word-wrap:break-word">\r\n<div class="WordSection1">\r\n<p class="MsoNormal"><span style="font-size:11.0pt">Please click on this <a href="https://www.*****.com/*****.html">\r\nURL</a> in order to keep your account active. Failure to do so will result in immediate termination of our services.<o:p></o:p></span></p>\r\n<p class="MsoNormal"><span style="font-size:11.0pt"><o:p>&nbsp;</o:p></span></p>\r\n<p class="MsoNormal"><span style="font-size:11.0pt"><img border="0" width="150" height="150" style="width:1.5625in;height:1.5625in" id="Picture_x0020_7" src="cid:image001.png@01D6E5D2.C0BEA220" alt="*****+*****="></span><span style="font-size:11.0pt"><o:p></o:p></span></p>\r\n<p class="MsoNormal"><span style="font-size:11.0pt"><o:p>&nbsp;</o:p></span></p>\r\n<p class="MsoNormal"><span style="font-size:11.0pt"><o:p>&nbsp;</o:p></span></p>\r\n<p class="MsoNormal"><span style="font-size:11.0pt">Thank you,<o:p></o:p></span></p>\r\n<p class="MsoNormal"><span style="font-size:11.0pt">-Customer Service<o:p></o:p></span></p>\r\n<p class="MsoNormal"><span style="font-size:11.0pt"><o:p>&nbsp;</o:p></span></p>\r\n<p class="MsoNormal"><span style="font-size:11.0pt"><o:p>&nbsp;</o:p></span></p>\r\n</div>\r\n</body>\r\n</html>\r\n', 'md5': '*****', 'sha256': '*****', 'match_priority': 2, 'attachments_count': 1, 'comments_count': 0, 'rules_count': 1, 'urls_count': 1, 'tags': ['999', '888'], 'categorization_tags': ['three1', 'two', 'one'], 'processed_at': '2021-08-31T20:10:39.487Z', 'created_at': '2021-01-08T20:28:05.372Z', 'updated_at': '2021-08-31T20:08:52.*****2Z'}, 'relationships': {'assignee': {'links': {'self': 'https://*****.phishmecloud.com/api/*****', 'related': 'https://*****.phishmecloud.com/api/*****'}, 'data': None}, 'category': {'links': {'self': 'https://*****.phishmecloud.com/api/*****', 'related': 'https://*****.phishmecloud.com/api/*****'}, 'data': {'type': 'categories', 'id': '24'}}, 'cluster': {'links': {'self': 'https://*****.phishmecloud.com/api/*****', 'related': 'https://*****.phishmecloud.com/api/*****'}, 'data': {'type': 'clusters', 'id': '223'}}, 'reporter': {'links': {'self': 'https://*****.phishmecloud.com/api/*****', 'related': 'https://*****.phishmecloud.com/api/*****'}, 'data': {'type': 'reporters', 'id': '24'}}, 'attachment_payloads': {'links': {'self': 'https://*****.phishmecloud.com/api/*****', 'related': 'https://*****.phishmecloud.com/api/*****'}}, 'attachments': {'links': {'self': 'https://*****.phishmecloud.com/api/*****', 'related': 'https://*****.phishmecloud.com/api/*****'}}, 'domains': {'links': {'self': 'https://*****.phishmecloud.com/api/*****', 'related': 'https://*****.phishmecloud.com/api/*****'}}, 'headers': {'links': {'self': 'https://*****.phishmecloud.com/api/*****', 'related': 'https://*****.phishmecloud.com/api/*****'}}, 'hostnames': {'links': {'self': 'https://*****.phishmecloud.com/api/*****', 'related': 'https://*****.phishmecloud.com/api/*****'}}, 'urls': {'links': {'self': 'https://*****.phishmecloud.com/api/*****', 'related': 'https://*****.phishmecloud.com/api/*****'}}, 'rules': {'links': {'self': 'https://*****.phishmecloud.com/api/*****', 'related': 'https://*****.phishmecloud.com/api/*****'}}, 'threat_indicators': {'links': {'self': 'https://*****.phishmecloud.com/api/*****', 'related': 'https://*****.phishmecloud.com/api/*****'}}, 'comments': {'links': {'self': 'https://*****.phishmecloud.com/api/*****', 'related': 'https://*****.phishmecloud.com/api/*****'}}}, 'meta': {'risk_score_summary': {'integrations': 75, 'vip': 5, 'reporter': 15, 'rules': 0}}}

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.

Categorize Report 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 Cofense Triage V2 portal. Refer to the HTTP Status Code Registry for details.

Status Code: 404.

Message

The raw data or captured key error message from the integration API server about the API request failure.

Message: The requested resource does not exist.

Error Sample Data

Categorize Report failed.

Status Code: 404.

Message: The requested resource does not exist.

Delete Comments

Deletes comments.

READER NOTE

The parameter Comment IDs is required to run this command.

Run the List Comment command to obtain Comment IDs. Comment IDs can be found in the returned raw data at the path $.data[*].id.

Input

Input Parameter

Required/Optional

Description

Example

Comment IDs

Required

The IDs of the comments to be deleted. Comment ID can be obtained using the List Comment command.

[ "*****" ]

Output

Raw Data

The primary response data from the API request.

D3 customizes the raw data by adding "commentID" and "actionResult" fields.

SAMPLE DATA

CODE
[
    {
        "commentID": "*****",
        "actionResult": "Delete the comment successfully"
    }
]
Return Data

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

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

  • A connection issue with the integration

  • The API returned an error message

  • No response from the API

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

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

SAMPLE DATA

CODE
Successful
Result

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

SAMPLE DATA

commentID

actionResult

*****

Delete the comment successfully

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.

Delete 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 Cofense Triage V2 portal. Refer to the HTTP Status Code Registry for details.

Status Code: 404.

Message

The raw data or captured key error message from the integration API server about the API request failure.

Message: The requested resource does not exist.

Error Sample Data

Delete Comments failed.

Status Code: 404.

Message: The requested resource does not exist.

Download Attachments

Download attachments.

READER NOTE

The parameter Attachment IDs is required to run this command.

  • Run the Get Report Attachments command to obtain Attachment IDs. Attachment IDs can be found in the returned raw data at the path $.[*]id.

Input

Input Parameter

Required/Optional

Description

Example

Attachment IDs

Required

The ID(s) of the attachment(s) to be downloaded. Attachment IDs can be obtained using the Get Report Attachments command.

1

Output

Raw Data

The primary response data from the API request.

SAMPLE DATA

CODE
[
    {
        "attachmentID": "*****",
        "fileId": "*****",
        "fileName": "*****.pdf",
        "size": 640751,
        "md5": "***********",
        "sha1": "***********",
        "sha256": "***********"
    }
]
Key Fields

Common cyber security indicators such as risk levels, risk level names, 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
{
  "FileIds": ["*****"],
  "FileNames": ["*****.pdf"]
}
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
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.

Download Attachments 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 Cofense Triage V2 portal. Refer to the HTTP Status Code Registry for details.

Status Code: 404.

Message

The raw data or captured key error message from the integration API server about the API request failure.

Message: The requested resource does not exist.

Error Sample Data

Download Attachments failed.

Status Code: 404.

Message: The requested resource does not exist.

Download Original Report

Downloads the raw email associated with the report.

READER NOTE

Report ID is a required parameter to run this command.

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

Input

Input Parameter

Required/Optional

Description

Example

Report ID

Required

The ID of the report to be downloaded. Report ID can be obtained using the Fetch Event command.

*****

Output

Raw Data

The primary response data from the API request.

D3 customizes the raw data by adding "fileId" and "fileName" fields.

SAMPLE DATA

CODE
{
    "fileId": "*****",
    "fileName": "*****.eml",
    "md5": "**************",
    "sha1": "**************",
    "sha256": "**************"
}
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
{
  "FileId": *****
}
Return Data

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

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

  • A connection issue with the integration

  • The API returned an error message

  • No response from the API

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

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

SAMPLE DATA

CODE
Successful
Result

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

SAMPLE DATA

fileId

*****

fileName

*****.eml

md5

**************

sha1

**************

sha256

**************

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.

Download Original Report 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 Cofense Triage V2 portal. Refer to the HTTP Status Code Registry for details.

Status Code: 404.

Message

The raw data or captured key error message from the integration API server about the API request failure.

Message: The requested resource does not exist.

Error Sample Data

Download Original Report failed.

Status Code: 404.

Message: The requested resource does not exist.

Fetch Event

Retrieves a list of events with details based on the specified criteria. These events consist of reported emails ingested by Cofense Triage, and include components like headers, body, domains and URLs, attachments and hashes, along with additional information such as risk score.

Input

Input Parameter

Required/Optional

Description

Example

Start Time

Required

The start time of the time range, in UTC time.

2021-05-25 00:00

End Time

Required

The end time of the time range, in UTC time.

2021-05-26 00:00

Number of Event(s) Fetched

Optional

The maximum number of events to return. The default value of this field is 20.

20

Search Condition

Optional

The query string to define search condition. The query format is from=<fromValue> subject=<subjectValue> body=<bodyValue> priority=<priorityValue> riskscore=<riskcoreValue> location=<locationValue>. The valid value for priority is 1, 2 , 3, 4, or 5. The valid values for riskscord is from 0 to 100. You can specify multiple values as a comma-separated list. Doing so returns records that match ANY of the supplied values. If the value of the from, subject, or body field contains a space, then the double quotation is needed. For example, "wherever I". The Cofense filter syntax "filter[ATTRIBUTE_OP]=VALUE" can be used for all other fields that are not listed in the description. Please refer to (https://*****.phishmecloud.com/docs/api/v2/index.html#filtering) for the available operators. For example filter[tags_all]=abc,efg will return the events only with both tags "abc" and "efg".

from=*****@*****.com subject="may Rome" body="wherever I" priority=1 riskscore=20 location=inbox,reconnaissance filter[tags_all]=abc,efg

Output

Raw Data

The primary response data from the API request.

SAMPLE DATA

CODE
{
    "data": [
        {
            "id": "*****",
            "type": "reports",
            "links": {
                "self": "https://*****.phishmecloud.com/api/*****"
            },
            "attributes": {
                "location": "Processed",
                "risk_score": 31,
                "from_address": "*****@*****.com",
                "subject": "FW: Wherever I may Rome",
                "received_at": "2021-08-23T02:29:09.000Z",
                "reported_at": "2021-08-23T02:29:09.000Z",
                "raw_headers": "Date: Mon, 23 Aug 2021 02:40:21 +0000\r\nFrom: *****@*****.com\r\nTo: *****@*****.com\r\nMessage-ID: <*****@*****.com.mail>\r\nSubject: FW: Wherever I may Rome\r\nMime-Version: 1.0\r\nContent-Type: multipart/mixed;\r\n boundary=\"--==_mimepart_*****\"\r\nContent-Transfer-Encoding: 7bit",
                "text_body": "Cluster of 3\r\n\r\nFrom: ***** ***** <*****@*****.com>\r\nDate: Sunday, August 22, 2021 at 10:26 PM\r\nTo: ***** ***** <*****@*****.com>\r\nSubject: Wherever I may Rome\r\n\r\n*****.net/***<https://*****.net/***>\r\n\r\nThat’s it\r\n",
                "html_body": "<html xmlns:o=\"urn:schemas-microsoft-com:office:office\" xmlns:w=\"urn:schemas-microsoft-com:office:word\" xmlns:m=\"http://*****.microsoft.com/*****\" xmlns=\"http://www.***.org/***\">\r\n<head>\r\n<meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\">\r\n<meta name=\"Generator\" content=\"Microsoft Word 15 (filtered medium)\">\r\n<style><!--\r\n/* Font Definitions */\r\n@font-face\r\n\t{font-family:\"Cambria Math\";\r\n\tpanose-1:2 4 5 3 5 4 6 3 2 4;}\r\n@font-face\r\n\t{font-family:Calibri;\r\n\tpanose-1:2 15 5 2 2 2 4 3 2 4;}\r\n/* Style Definitions */\r\np.MsoNormal, li.MsoNormal, div.MsoNormal\r\n\t{margin:0in;\r\n\tfont-size:12.0pt;\r\n\tfont-family:\"Calibri\",sans-serif;}\r\na:link, span.MsoHyperlink\r\n\t{mso-style-priority:99;\r\n\tcolor:#0563C1;\r\n\ttext-decoration:underline;}\r\nspan.EmailStyle19\r\n\t{mso-style-type:personal-reply;\r\n\tfont-family:\"Calibri\",sans-serif;\r\n\tcolor:windowtext;}\r\n.MsoChpDefault\r\n\t{mso-style-type:export-only;\r\n\tfont-size:10.0pt;}\r\n@page WordSection1\r\n\t{size:8.5in 11.0in;\r\n\tmargin:1.0in 1.0in 1.0in 1.0in;}\r\ndiv.WordSection1\r\n\t{page:WordSection1;}\r\n--></style>\r\n</head>\r\n<body lang=\"EN-US\" link=\"#0563C1\" vlink=\"#9*****F72\" style=\"word-wrap:break-word\">\r\n<div class=\"WordSection1\">\r\n<p class=\"MsoNormal\"><span style=\"font-size:11.0pt\">Cluster of 3<o:p></o:p></span></p>\r\n<p class=\"MsoNormal\"><span style=\"font-size:11.0pt\"><o:p>&nbsp;</o:p></span></p>\r\n<div style=\"border:none;border-top:solid #B5C4DF 1.0pt;padding:3.0pt 0in 0in 0in\">\r\n<p class=\"MsoNormal\"><b><span style=\"color:black\">From: </span></b><span style=\"color:black\">***** ***** &lt;*****@*****.com&gt;<br>\r\n<b>Date: </b>Sunday, August 22, 2021 at 10:26 PM<br>\r\n<b>To: </b>***** ***** &lt;*****@*****.com&gt;<br>\r\n<b>Subject: </b>Wherever I may Rome<o:p></o:p></span></p>\r\n</div>\r\n<div>\r\n<p class=\"MsoNormal\"><span style=\"font-size:11.0pt\"><o:p>&nbsp;</o:p></span></p>\r\n</div>\r\n<p class=\"MsoNormal\"><span style=\"font-size:11.0pt\"><a href=\"https://*****.net/***\">*****.net/***</a><o:p></o:p></span></p>\r\n<p class=\"MsoNormal\"><span style=\"font-size:11.0pt\"><o:p>&nbsp;</o:p></span></p>\r\n<p class=\"MsoNormal\"><span style=\"font-size:11.0pt\">That’s it</span><o:p></o:p></p>\r\n</div>\r\n</body>\r\n</html>\r\n",
                "md5": "*****",
                "sha256": "*****",
                "match_priority": 2,
                "attachments_count": 12,
                "comments_count": 0,
                "rules_count": 3,
                "urls_count": 1,
                "tags": [],
                "categorization_tags": [
                    "R1"
                ],
                "processed_at": "2021-08-23T02:47:15.136Z",
                "created_at": "2021-08-23T02:40:21.585Z",
                "updated_at": "2021-08-23T02:48:48.100Z"
            },
            "relationships": {
                "assignee": {
                    "links": {
                        "self": "https://*****.phishmecloud.com/api/*****",
                        "related": "https://*****.phishmecloud.com/api/*****"
                    },
                    "data": null
                },
                "category": {
                    "links": {
                        "self": "https://*****.phishmecloud.com/api/*****",
                        "related": "https://*****.phishmecloud.com/api/*****"
                    },
                    "data": {
                        "type": "categories",
                        "id": "8"
                    }
                },
                "cluster": {
                    "links": {
                        "self": "https://*****.phishmecloud.com/api/*****",
                        "related": "https://*****.phishmecloud.com/api/*****"
                    },
                    "data": {
                        "type": "clusters",
                        "id": "352"
                    }
                },
                "reporter": {
                    "links": {
                        "self": "https://*****.phishmecloud.com/api/*****",
                        "related": "https://*****.phishmecloud.com/api/*****"
                    },
                    "data": {
                        "type": "reporters",
                        "id": "24"
                    }
                },
                "attachment_payloads": {
                    "links": {
                        "self": "https://*****.phishmecloud.com/api/*****",
                        "related": "https://*****.phishmecloud.com/api/*****"
                    }
                },
                "attachments": {
                    "links": {
                        "self": "https://*****.phishmecloud.com/api/*****",
                        "related": "https://*****.phishmecloud.com/api/*****"
                    }
                },
                "domains": {
                    "links": {
                        "self": "https://*****.phishmecloud.com/api/*****",
                        "related": "https://*****.phishmecloud.com/api/*****"
                    }
                },
                "headers": {
                    "links": {
                        "self": "https://*****.phishmecloud.com/api/*****",
                        "related": "https://*****.phishmecloud.com/api/*****"
                    }
                },
                "hostnames": {
                    "links": {
                        "self": "https://*****.phishmecloud.com/api/*****",
                        "related": "https://*****.phishmecloud.com/api/*****"
                    }
                },
                "urls": {
                    "links": {
                        "self": "https://*****.phishmecloud.com/api/*****",
                        "related": "https://*****.phishmecloud.com/api/*****"
                    }
                },
                "rules": {
                    "links": {
                        "self": "https://*****.phishmecloud.com/api/*****",
                        "related": "https://*****.phishmecloud.com/api/*****"
                    }
                },
                "threat_indicators": {
                    "links": {
                        "self": "https://*****.phishmecloud.com/api/*****",
                        "related": "https://*****.phishmecloud.com/api/*****"
                    }
                },
                "comments": {
                    "links": {
                        "self": "https://*****.phishmecloud.com/api/*****",
                        "related": "https://*****.phishmecloud.com/api/*****"
                    }
                }
            },
            "meta": {
                "risk_score_summary": {
                    "integrations": 9,
                    "vip": 5,
                    "reporter": 15,
                    "rules": 2
                }
            }
        },
        {
            "id": "944",
            "type": "reports",
            "links": {
                "self": "https://*****.phishmecloud.com/api/*****"
            },
            "attributes": {
                "location": "Processed",
                "risk_score": 31,
                "from_address": "*****@*****.com",
                "subject": "FW: Wherever I may Rome",
                "received_at": "2021-08-23T02:28:48.000Z",
                "reported_at": "2021-08-23T02:28:47.000Z",
                "raw_headers": "Date: Mon, 23 Aug 2021 02:29:33 +0000\r\nFrom: *****@*****.com\r\nTo: *****@*****.com\r\nMessage-ID: <****@*****.com.mail>\r\nSubject: FW: Wherever I may Rome\r\nMime-Version: 1.0\r\nContent-Type: multipart/mixed;\r\n boundary=\"--==_mimepart_*****c\"\r\nContent-Transfer-Encoding: 7bit",
                "text_body": "\r\n\r\nFrom: ***** ***** <*****@*****.com>\r\nDate: Sunday, August 22, 2021 at 10:26 PM\r\nTo: ***** ***** <*****@*****.com>\r\nSubject: Wherever I may Rome\r\n\r\n*****.net/***<https://*****.net/***>\r\n\r\nThat’s it\r\n",
                "html_body": "<html xmlns:o=\"urn:schemas-microsoft-com:office:office\" xmlns:w=\"urn:schemas-microsoft-com:office:word\" xmlns:m=\"http://*****.microsoft.com/*****\" xmlns=\"http://www.***.org/***\">\r\n<head>\r\n<meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\">\r\n<meta name=\"Generator\" content=\"Microsoft Word 15 (filtered medium)\">\r\n<style><!--\r\n/* Font Definitions */\r\n@font-face\r\n\t{font-family:\"Cambria Math\";\r\n\tpanose-1:2 4 5 3 5 4 6 3 2 4;}\r\n@font-face\r\n\t{font-family:Calibri;\r\n\tpanose-1:2 15 5 2 2 2 4 3 2 4;}\r\n/* Style Definitions */\r\np.MsoNormal, li.MsoNormal, div.MsoNormal\r\n\t{margin:0in;\r\n\tfont-size:12.0pt;\r\n\tfont-family:\"Calibri\",sans-serif;}\r\na:link, span.MsoHyperlink\r\n\t{mso-style-priority:99;\r\n\tcolor:#0563C1;\r\n\ttext-decoration:underline;}\r\nspan.EmailStyle19\r\n\t{mso-style-type:personal-reply;\r\n\tfont-family:\"Calibri\",sans-serif;\r\n\tcolor:windowtext;}\r\n.MsoChpDefault\r\n\t{mso-style-type:export-only;\r\n\tfont-size:10.0pt;}\r\n@page WordSection1\r\n\t{size:8.5in 11.0in;\r\n\tmargin:1.0in 1.0in 1.0in 1.0in;}\r\ndiv.WordSection1\r\n\t{page:WordSection1;}\r\n--></style>\r\n</head>\r\n<body lang=\"EN-US\" link=\"#0563C1\" vlink=\"#9*****F72\" style=\"word-wrap:break-word\">\r\n<div class=\"WordSection1\">\r\n<p class=\"MsoNormal\"><span style=\"font-size:11.0pt\"><o:p>&nbsp;</o:p></span></p>\r\n<p class=\"MsoNormal\"><span style=\"font-size:11.0pt\"><o:p>&nbsp;</o:p></span></p>\r\n<div style=\"border:none;border-top:solid #B5C4DF 1.0pt;padding:3.0pt 0in 0in 0in\">\r\n<p class=\"MsoNormal\"><b><span style=\"color:black\">From: </span></b><span style=\"color:black\">***** ***** &lt;*****@*****.com&gt;<br>\r\n<b>Date: </b>Sunday, August 22, 2021 at 10:26 PM<br>\r\n<b>To: </b>***** ***** &lt;*****@*****.com&gt;<br>\r\n<b>Subject: </b>Wherever I may Rome<o:p></o:p></span></p>\r\n</div>\r\n<div>\r\n<p class=\"MsoNormal\"><span style=\"font-size:11.0pt\"><o:p>&nbsp;</o:p></span></p>\r\n</div>\r\n<p class=\"MsoNormal\"><span style=\"font-size:11.0pt\"><a href=\"https://*****.net/***\">*****.net/***</a><o:p></o:p></span></p>\r\n<p class=\"MsoNormal\"><span style=\"font-size:11.0pt\"><o:p>&nbsp;</o:p></span></p>\r\n<p class=\"MsoNormal\"><span style=\"font-size:11.0pt\">That’s it</span><o:p></o:p></p>\r\n</div>\r\n</body>\r\n</html>\r\n",
                "md5": "*****",
                "sha256": "*****",
                "match_priority": 2,
                "attachments_count": 12,
                "comments_count": 0,
                "rules_count": 3,
                "urls_count": 1,
                "tags": [],
                "categorization_tags": [
                    "R3-*****"
                ],
                "processed_at": "2021-08-23T02:48:10.195Z",
                "created_at": "2021-08-23T02:29:33.381Z",
                "updated_at": "2021-08-23T02:48:49.457Z"
            },
            "relationships": {
                "assignee": {
                    "links": {
                        "self": "https://*****.phishmecloud.com/api/*****",
                        "related": "https://*****.phishmecloud.com/api/*****"
                    },
                    "data": null
                },
                "category": {
                    "links": {
                        "self": "https://*****.phishmecloud.com/api/*****",
                        "related": "https://*****.phishmecloud.com/api/*****"
                    },
                    "data": {
                        "type": "categories",
                        "id": "8"
                    }
                },
                "cluster": {
                    "links": {
                        "self": "https://*****.phishmecloud.com/api/*****",
                        "related": "https://*****.phishmecloud.com/api/*****"
                    },
                    "data": {
                        "type": "clusters",
                        "id": "352"
                    }
                },
                "reporter": {
                    "links": {
                        "self": "https://*****.phishmecloud.com/api/*****",
                        "related": "https://*****.phishmecloud.com/api/*****"
                    },
                    "data": {
                        "type": "reporters",
                        "id": "*****"
                    }
                },
                "attachment_payloads": {
                    "links": {
                        "self": "https://*****.phishmecloud.com/api/*****",
                        "related": "https://*****.phishmecloud.com/api/*****"
                    }
                },
                "attachments": {
                    "links": {
                        "self": "https://*****.phishmecloud.com/api/*****",
                        "related": "https://*****.phishmecloud.com/api/*****"
                    }
                },
                "domains": {
                    "links": {
                        "self": "https://*****.phishmecloud.com/api/*****",
                        "related": "https://*****.phishmecloud.com/api/*****"
                    }
                },
                "headers": {
                    "links": {
                        "self": "https://*****.phishmecloud.com/api/*****",
                        "related": "https://*****.phishmecloud.com/api/*****"
                    }
                },
                "hostnames": {
                    "links": {
                        "self": "https://*****.phishmecloud.com/api/*****",
                        "related": "https://*****.phishmecloud.com/api/*****"
                    }
                },
                "urls": {
                    "links": {
                        "self": "hhttps://*****.phishmecloud.com/api/*****",
                        "related": "https://*****.phishmecloud.com/api/*****"
                    }
                },
                "rules": {
                    "links": {
                        "self": "https://*****.phishmecloud.com/api/*****",
                        "related": "https://*****.phishmecloud.com/api/*****"
                    }
                },
                "threat_indicators": {
                    "links": {
                        "self": "https://*****.phishmecloud.com/api/*****",
                        "related": "https://*****.phishmecloud.com/api/*****"
                    }
                },
                "comments": {
                    "links": {
                        "self": "https://*****.phishmecloud.com/api/*****",
                        "related": "https://*****.phishmecloud.com/api/*****"
                    }
                }
            },
            "meta": {
                "risk_score_summary": {
                    "integrations": 9,
                    "vip": 5,
                    "reporter": 15,
                    "rules": 2
                }
            }
        }
    ],
    "meta": {
        "record_count": 2,
        "page_count": 1
    },
    "links": {
        "first": "https://*****.phishmecloud.com/api/*****",
        "last": "https://*****.phishmecloud.com/api/*****"
    }
}
Key Fields

Common cyber security indicators such as unique IDs, file hash values, CVE numbers, IP addresses, etc., will be extracted from Raw Data as Key Fields.

The system stores these key fields in the path $.[playbookTask].outputData. You can use these key-value pairs as data points for playbook task inputs.

SAMPLE DATA

CODE
{
  "Ids": ["*****"],
  "Locations": ["Processed"],
  "RiskScores": [31],
  "FromAddresses": ["*****@*****.com"],
  "Subjects": [ "FW: Wherever I may Rome" ],
  "ReceivedAt": [ "2021-08-23 02:29:09" ],
  "RawHeaders": [
    "Date: Mon, 23 Aug 2021 02:40:21 +0000\r\nFrom: *****@*****.com\r\nTo: *****@*****.com\r\nMessage-ID: <*****@*****.com.mail>\r\nSubject: FW: Wherever I may Rome\r\nMime-Version: 1.0\r\nContent-Type: multipart/mixed;\r\n boundary=\"--==_mimepart_*****\"\r\nContent-Transfer-Encoding: 7bit"
   ],
   "TextBodies": [ "Cluster of 3\r\n\r\nFrom: ***** ***** <*****@*****.com>\r\nDate: Sunday, August 22, 2021 at 10:26 PM\r\nTo: ***** ***** <*****@*****.com>\r\nSubject: Wherever I may Rome\r\n\r\n*****.net/***<https://*****.net/***>\r\n\r\nThat's it\r\n" ],
   "MD5s": ["*****"],
   "SHA256s": ["*****"],
   "MatchPriorities": [2],
   "CreatedAt": ["2021-07-01T13:11:34.517Z"]
}
Return Data

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

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

  • A connection issue with the integration

  • The API returned an error message

  • No response from the API

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

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

SAMPLE DATA

CODE
Successful
Result

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

SAMPLE DATA

data

  • {'id': '*****', 'type': 'reports', 'links': {'self': 'https://*****.phishmecloud.com/api/*****'}, 'attributes': {'location': 'Processed', 'risk_score': 31, 'from_address': '*****@*****.com', 'subject': 'FW: Wherever I may Rome', 'received_at': '2021-08-23T02:29:09.000Z', 'reported_at': '2021-08-23T02:29:09.000Z', 'raw_headers': 'Date: Mon, 23 Aug 2021 02:40:21 +0000\r\nFrom: *****@*****.com\r\nTo: *****@*****.com\r\nMessage-ID: <*****@*****.com.mail>\r\nSubject: FW: Wherever I may Rome\r\nMime-Version: 1.0\r\nContent-Type: multipart/mixed;\r\n boundary="--==_mimepart_*****"\r\nContent-Transfer-Encoding: 7bit', 'text_body': 'Cluster of 3\r\n\r\nFrom: ***** ***** <*****@*****.com>\r\nDate: Sunday, August 22, 2021 at 10:26 PM\r\nTo: ***** ***** <*****@*****.com>\r\nSubject: Wherever I may Rome\r\n\r\n*****.net/***<https://*****.net/***>\r\n\r\nThat’s it\r\n', 'html_body': '<html xmlns:o="urn:schemas-microsoft-com:office:office" xmlns:w="urn:schemas-microsoft-com:office:word" xmlns:m="http://*****.microsoft.com/*****" xmlns="http://www.w3.org/TR/REC-html40 ">\r\n<head>\r\n<meta http-equiv="Content-Type" content="text/html; charset=utf-8">\r\n<meta name="Generator" content="Microsoft Word 15 (filtered medium)">\r\n<style><!--\r\n/* Font Definitions */\r\n@font-face\r\n\t{font-family:"Cambria Math";\r\n\tpanose-1:2 4 5 3 5 4 6 3 2 4;}\r\n@font-face\r\n\t{font-family:Calibri;\r\n\tpanose-1:2 15 5 2 2 2 4 3 2 4;}\r\n/* Style Definitions */\r\np.MsoNormal, li.MsoNormal, div.MsoNormal\r\n\t{margin:0in;\r\n\tfont-size:12.0pt;\r\n\tfont-family:"Calibri",sans-serif;}\r\na:link, span.MsoHyperlink\r\n\t{mso-style-priority:99;\r\n\tcolor:#0563C1;\r\n\ttext-decoration:underline;}\r\nspan.EmailStyle19\r\n\t{mso-style-type:personal-reply;\r\n\tfont-family:"Calibri",sans-serif;\r\n\tcolor:windowtext;}\r\n.MsoChpDefault\r\n\t{mso-style-type:export-only;\r\n\tfont-size:10.0pt;}\r\n@page WordSection1\r\n\t{size:8.5in 11.0in;\r\n\tmargin:1.0in 1.0in 1.0in 1.0in;}\r\ndiv.WordSection1\r\n\t{page:WordSection1;}\r\n--></style>\r\n</head>\r\n<body lang="EN-US" link="#0563C1" vlink="#9*****F72" style="word-wrap:break-word">\r\n<div class="WordSection1">\r\n<p class="MsoNormal"><span style="font-size:11.0pt">Cluster of 3<o:p></o:p></span></p>\r\n<p class="MsoNormal"><span style="font-size:11.0pt"><o:p>&nbsp;</o:p></span></p>\r\n<div style="border:none;border-top:solid #B5C4DF 1.0pt;padding:3.0pt 0in 0in 0in">\r\n<p class="MsoNormal"><b><span style="color:black">From: </span></b><span style="color:black">***** ***** &lt;*****@*****.com&gt;<br>\r\n<b>Date: </b>Sunday, August 22, 2021 at 10:26 PM<br>\r\n<b>To: </b>***** ***** &lt;*****@*****.com&gt;<br>\r\n<b>Subject: </b>Wherever I may Rome<o:p></o:p></span></p>\r\n</div>\r\n<div>\r\n<p class="MsoNormal"><span style="font-size:11.0pt"><o:p>&nbsp;</o:p></span></p>\r\n</div>\r\n<p class="MsoNormal"><span style="font-size:11.0pt"><a href="https://*****.net/***">*****.net/***</a><o:p></o:p></span></p>\r\n<p class="MsoNormal"><span style="font-size:11.0pt"><o:p>&nbsp;</o:p></span></p>\r\n<p class="MsoNormal"><span style="font-size:11.0pt">That’s it</span><o:p></o:p></p>\r\n</div>\r\n</body>\r\n</html>\r\n', 'md5': '*****', 'sha256': '*****', 'match_priority': 2, 'attachments_count': 12, 'comments_count': 0, 'rules_count': 3, 'urls_count': 1, 'tags': [], 'categorization_tags': ['R1'], 'processed_at': '2021-08-23T02:47:15.136Z', 'created_at': '2021-08-23T02:40:21.585Z', 'updated_at': '2021-08-23T02:48:48.100Z'}, 'relationships': {'assignee': {'links': {'self': 'https://*****.phishmecloud.com/api/*****', 'related': 'https://*****.phishmecloud.com/api/*****'}, 'data': None}, 'category': {'links': {'self': 'https://*****.phishmecloud.com/api/*****', 'related': 'https://*****.phishmecloud.com/api/*****'}, 'data': {'type': 'categories', 'id': '8'}}, 'cluster': {'links': {'self': 'https://*****.phishmecloud.com/api/*****', 'related': 'https://*****.phishmecloud.com/api/*****'}, 'data': {'type': 'clusters', 'id': '352'}}, 'reporter': {'links': {'self': 'https://*****.phishmecloud.com/api/*****', 'related': 'https://*****.phishmecloud.com/api/*****'}, 'data': {'type': 'reporters', 'id': '24'}}, 'attachment_payloads': {'links': {'self': 'https://*****.phishmecloud.com/api/*****', 'related': 'https://*****.phishmecloud.com/api/*****'}}, 'attachments': {'links': {'self': 'https://*****.phishmecloud.com/api/*****', 'related': 'https://*****.phishmecloud.com/api/*****'}}, 'domains': {'links': {'self': 'https://*****.phishmecloud.com/api/*****', 'related': 'https://*****.phishmecloud.com/api/*****'}}, 'headers': {'links': {'self': 'https://*****.phishmecloud.com/api/*****', 'related': 'https://*****.phishmecloud.com/api/*****'}}, 'hostnames': {'links': {'self': 'https://*****.phishmecloud.com/api/*****', 'related': 'https://*****.phishmecloud.com/api/*****'}}, 'urls': {'links': {'self': 'https://*****.phishmecloud.com/api/*****', 'related': 'https://*****.phishmecloud.com/api/*****'}}, 'rules': {'links': {'self': 'https://*****.phishmecloud.com/api/*****', 'related': 'https://*****.phishmecloud.com/api/*****'}}, 'threat_indicators': {'links': {'self': 'https://*****.phishmecloud.com/api/*****', 'related': 'https://*****.phishmecloud.com/api/*****'}}, 'comments': {'links': {'self': 'https://*****.phishmecloud.com/api/*****', 'related': 'https://*****.phishmecloud.com/api/*****'}}}, 'meta': {'risk_score_summary': {'integrations': 9, 'vip': 5, 'reporter': 15, 'rules': 2}}}

  • {'id': '944', 'type': 'reports', 'links': {'self': 'https://*****.phishmecloud.com/api/*****'}, 'attributes': {'location': 'Processed', 'risk_score': 31, 'from_address': '*****@*****.com', 'subject': 'FW: Wherever I may Rome', 'received_at': '2021-08-23T02:28:48.000Z', 'reported_at': '2021-08-23T02:28:47.000Z', 'raw_headers': 'Date: Mon, 23 Aug 2021 02:29:33 +0000\r\nFrom: *****@*****.com\r\nTo: *****@*****.com\r\nMessage-ID: <****@*****.phishmecloud.com.mail>\r\nSubject: FW: Wherever I may Rome\r\nMime-Version: 1.0\r\nContent-Type: multipart/mixed;\r\n boundary="--==_mimepart_*****c"\r\nContent-Transfer-Encoding: 7bit', 'text_body': '\r\n\r\nFrom: ***** ***** <*****@*****.com>\r\nDate: Sunday, August 22, 2021 at 10:26 PM\r\nTo: ***** ***** <*****@*****.com>\r\nSubject: Wherever I may Rome\r\n\r\n*****.net/***<https://*****.net/***>\r\n\r\nThat’s it\r\n', 'html_body': '<html xmlns:o="urn:schemas-microsoft-com:office:office" xmlns:w="urn:schemas-microsoft-com:office:word" xmlns:m="http://*****.microsoft.com/*****" xmlns="http://www.w3.org/TR/REC-html40 ">\r\n<head>\r\n<meta http-equiv="Content-Type" content="text/html; charset=utf-8">\r\n<meta name="Generator" content="Microsoft Word 15 (filtered medium)">\r\n<style><!--\r\n/* Font Definitions */\r\n@font-face\r\n\t{font-family:"Cambria Math";\r\n\tpanose-1:2 4 5 3 5 4 6 3 2 4;}\r\n@font-face\r\n\t{font-family:Calibri;\r\n\tpanose-1:2 15 5 2 2 2 4 3 2 4;}\r\n/* Style Definitions */\r\np.MsoNormal, li.MsoNormal, div.MsoNormal\r\n\t{margin:0in;\r\n\tfont-size:12.0pt;\r\n\tfont-family:"Calibri",sans-serif;}\r\na:link, span.MsoHyperlink\r\n\t{mso-style-priority:99;\r\n\tcolor:#0563C1;\r\n\ttext-decoration:underline;}\r\nspan.EmailStyle19\r\n\t{mso-style-type:personal-reply;\r\n\tfont-family:"Calibri",sans-serif;\r\n\tcolor:windowtext;}\r\n.MsoChpDefault\r\n\t{mso-style-type:export-only;\r\n\tfont-size:10.0pt;}\r\n@page WordSection1\r\n\t{size:8.5in 11.0in;\r\n\tmargin:1.0in 1.0in 1.0in 1.0in;}\r\ndiv.WordSection1\r\n\t{page:WordSection1;}\r\n--></style>\r\n</head>\r\n<body lang="EN-US" link="#0563C1" vlink="#9*****F72" style="word-wrap:break-word">\r\n<div class="WordSection1">\r\n<p class="MsoNormal"><span style="font-size:11.0pt"><o:p>&nbsp;</o:p></span></p>\r\n<p class="MsoNormal"><span style="font-size:11.0pt"><o:p>&nbsp;</o:p></span></p>\r\n<div style="border:none;border-top:solid #B5C4DF 1.0pt;padding:3.0pt 0in 0in 0in">\r\n<p class="MsoNormal"><b><span style="color:black">From: </span></b><span style="color:black">***** ***** &lt;*****@*****.com&gt;<br>\r\n<b>Date: </b>Sunday, August 22, 2021 at 10:26 PM<br>\r\n<b>To: </b>***** ***** &lt;*****@*****.com&gt;<br>\r\n<b>Subject: </b>Wherever I may Rome<o:p></o:p></span></p>\r\n</div>\r\n<div>\r\n<p class="MsoNormal"><span style="font-size:11.0pt"><o:p>&nbsp;</o:p></span></p>\r\n</div>\r\n<p class="MsoNormal"><span style="font-size:11.0pt"><a href="https://*****.net/***">*****.net/***</a><o:p></o:p></span></p>\r\n<p class="MsoNormal"><span style="font-size:11.0pt"><o:p>&nbsp;</o:p></span></p>\r\n<p class="MsoNormal"><span style="font-size:11.0pt">That’s it</span><o:p></o:p></p>\r\n</div>\r\n</body>\r\n</html>\r\n', 'md5': '*****', 'sha256': '*****', 'match_priority': 2, 'attachments_count': 12, 'comments_count': 0, 'rules_count': 3, 'urls_count': 1, 'tags': [], 'categorization_tags': ['R3-*****'], 'processed_at': '2021-08-23T02:48:10.195Z', 'created_at': '2021-08-23T02:29:33.381Z', 'updated_at': '2021-08-23T02:48:49.457Z'}, 'relationships': {'assignee': {'links': {'self': 'https://*****.phishmecloud.com/api/*****', 'related': 'https://*****.phishmecloud.com/api/*****'}, 'data': None}, 'category': {'links': {'self': 'https://*****.phishmecloud.com/api/*****', 'related': 'https://*****.phishmecloud.com/api/*****'}, 'data': {'type': 'categories', 'id': '8'}}, 'cluster': {'links': {'self': 'https://*****.phishmecloud.com/api/*****', 'related': 'https://*****.phishmecloud.com/api/*****'}, 'data': {'type': 'clusters', 'id': '352'}}, 'reporter': {'links': {'self': 'https://*****.phishmecloud.com/api/*****', 'related': 'https://*****.phishmecloud.com/api/*****'}, 'data': {'type': 'reporters', 'id': '24'}}, 'attachment_payloads': {'links': {'self': 'https://*****.phishmecloud.com/api/*****', 'related': 'https://*****.phishmecloud.com/api/*****'}}, 'attachments': {'links': {'self': 'https://*****.phishmecloud.com/api/*****', 'related': 'https://*****.phishmecloud.com/api/*****'}}, 'domains': {'links': {'self': 'https://*****.phishmecloud.com/api/*****', 'related': 'https://*****.phishmecloud.com/api/*****'}}, 'headers': {'links': {'self': 'https://*****.phishmecloud.com/api/*****', 'related': 'https://*****.phishmecloud.com/api/*****'}}, 'hostnames': {'links': {'self': 'https://*****.phishmecloud.com/api/*****', 'related': 'https://*****.phishmecloud.com/api/*****'}}, 'urls': {'links': {'self': 'hhttps://*****.phishmecloud.com/api/*****', 'related': 'https://*****.phishmecloud.com/api/*****'}}, 'rules': {'links': {'self': 'https://*****.phishmecloud.com/api/*****', 'related': 'https://*****.phishmecloud.com/api/*****'}}, 'threat_indicators': {'links': {'self': 'https://*****.phishmecloud.com/api/*****', 'related': 'https://*****.phishmecloud.com/api/*****'}}, 'comments': {'links': {'self': 'https://*****.phishmecloud.com/api/*****', 'related': 'https://*****.phishmecloud.com/api/*****'}}}, 'meta': {'risk_score_summary': {'integrations': 9, 'vip': 5, 'reporter': 15, 'rules': 2}}}

meta

{'record_count': 2, 'page_count': 1}

links

{'first': 'https://*****.phishmecloud.com/api/*****', 'last': 'https://*****.phishmecloud.com/api/*****'}

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.

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 Cofense Triage V2 integration has some pre-configured field mappings for default field mapping.

  • Default Event Source
    The Default Event Source is the default set of field mappings that are applied when this fetch event command is executed. For out-of-the-box integrations, you will find a set of field mapping provided by the system. Default event source provides field mappings for common fields from fetched events. The default event source has a “Main Event JSON Path” (i.e., $.data) that is used to extract a batch of events from the response raw data. Click Edit Event Source to view the “Main Event JSON Path”.

    • Main Event JSON Path: $.data
      The Main Event JSON Path determines the root path where the system starts parsing raw response data into D3 event data. The JSON path begins with $, representing the root element. The path is formed by appending a sequence of child elements to $, each separated by a dot (.). Square brackets with nested quotation marks ([‘...’]) should be used to separate child elements in JSON arrays. For example, the root node of a JSON Path is data. The child node denoting the Unique Event Key field would be id. Putting it together, the JSON Path expression to extract the Unique Event Key is $.data.id.

The pre-configured field mappings are detailed below:

Field Name

Source Field

Unique Event Key

.id

Event Type

.type

Sender

.attributes.from_address

Email subject

.attributes.Subject

Start Time

.attributes.received_at

Message body

.attributes.text_body

File Hash MD5

.attributes.md5

File Hash SHA256

.attributes.sha256

Risk Score

.attributes.risk_score

Raw Headers

.attributes.raw_headers

Match Priority

.attributes.match_priority

location

.attributes.location

RiskScore

.attributes.risk_score

RawHeaders

.attributes.raw_headers

MatchPriority

.attributes.match_priority

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 Cofense Triage V2 portal. Refer to the HTTP Status Code Registry for details.

Status Code: 400.

Message

The raw data or captured key error message from the integration API server about the API request failure.

Message: The request could not be processed due to invalid syntax.

Error Sample Data

Fetch Event failed.

Status Code: 400.

Message: The request could not be processed due to invalid syntax.

Generic GET Command

Generic command to take retrieval or download action toward specified resource.

Input

Input Parameter

Required/Optional

Description

Example

Action

Optional

The action to be performed on the specified resource. Please note that the Download action is applicable only to Report, Attachment, and Attachment Payloads resources. When selecting the Download action, you must specify the Resource ID.

Download

Resource Name

Required

The name of the resource on which to take action. Please note that the Download action can only be applied to Attachments, Attachment Payloads, and Reports resources. The Retrieve action can be applied to all resources.

Reports

Resource ID

Optional

The ID of the resource on which to take action. If not specified, all resources of the specified Resource Name will be retrieved. For the Download action, the Resource ID is required.

*****

Filter

Optional

The filter conditions used to refine the returned resources. This parameter is only applicable when performing the Retrieve action without specifying the Resource ID.

filter[risk_score_gteq]=20[received_at_gteq]=2021-01-01

Output

Raw Data

The primary response data from the API request.

SAMPLE DATA

CODE
{
    "fileId": "*****",
    "fileName": "*****.eml",
    "md5": "*****",
    "sha1": "*****",
    "sha256": "*****"
}
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
Result

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

SAMPLE DATA

fileId

*****

fileName

*****.eml

md5

*****

sha1

*****

sha256

*****

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.

Generic GET Command 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 Cofense Triage V2 portal. Refer to the HTTP Status Code Registry for details.

Status Code: 400.

Message

The raw data or captured key error message from the integration API server about the API request failure.

Message: The request could not be processed due to invalid syntax.

Error Sample Data

Generic GET Command failed.

Status Code: 400.

Message: The request could not be processed due to invalid syntax.

Get Report Attachments

Retrieves all attachments of the specified reports.

READER NOTE

The parameter Report IDs is required to run this command.

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

Input

Input Parameter

Required/Optional

Description

Example

Report IDs

Required

The ID(s) of report(s) to get attachments. Report ID can be obtained using the Fetch Event command.

[ "*****" ]

Output

Raw Data

The primary response data from the API request.

SAMPLE DATA

CODE
[
    {
        "reportID": *****,
        "data": [
            {
                "id": *****,
                "type": "attachments"
            },
            {
                "id": *****,
                "type": "attachments"
            }
        ]
    }
]
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
Result

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

SAMPLE DATA

Reports Count

1

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 Report Attachments 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 Cofense Triage V2 portal. Refer to the HTTP Status Code Registry for details.

Status Code: 404.

Message

The raw data or captured key error message from the integration API server about the API request failure.

Message: The requested resource does not exist.

Error Sample Data

Get Report Attachments failed.

Status Code: 404.

Message: The requested resource does not exist.

Get Reports

Retrieves the specified report(s) by Report ID(s).

READER NOTE

The parameter Report IDs is required to run this command.

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

Input

Input Parameter

Required/Optional

Description

Example

Report IDs

Required

The ID of the report. Report ID can be obtained using the Fetch Event command.

[ "*****" ]

Output

Raw Data

The primary response data from the API request.

SAMPLE DATA

CODE
[
    {
        "data": {
            "id": "*****",
            "type": "reports",
            "links": {
                "self": "https://*****.phishmecloud.com/api/*****"
            },
            "attributes": {
                "location": "Processed",
                "risk_score": 31,
                "from_address": "*****@*****.com",
                "subject": "FW: Wherever I may Rome",
                "received_at": "2021-08-23T02:29:09.000Z",
                "reported_at": "2021-08-23T02:29:09.000Z",
                "raw_headers": "Date: Mon, 23 Aug 2021 02:40:21 +0000\r\nFrom: *****@*****.com\r\nTo: *****@*****.com\r\nMessage-ID: <*****@*****.*****.com.mail>\r\nSubject: FW: Wherever I may Rome\r\nMime-Version: 1.0\r\nContent-Type: multipart/mixed;\r\n boundary=\"--==_mimepart_*****\"\r\nContent-Transfer-Encoding: 7bit",
                "text_body": "Cluster of 3\r\n\r\nFrom: ***** ***** <*****@*****.com>\r\nDate: Sunday, August 22, 2021 at 10:26 PM\r\nTo: ***** ***** <*****@*****.com>\r\nSubject: Wherever I may Rome\r\n\r\nwww.*****.net/*****.html<http://www.*****.net/*****.html>\r\n\r\nThat's it\r\n",
                "html_body": "<html xmlns:o=\"urn:schemas-microsoft-com:office:office\" xmlns:w=\"urn:schemas-microsoft-com:office:word\" xmlns:m=\"http://*****.microsoft.com/*****\" xmlns=\"http://www.*****.org/*****\">\r\n<head>\r\n<meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\">\r\n<meta name=\"Generator\" content=\"Microsoft Word 15 (filtered medium)\">\r\n<style><!--\r\n/* Font Definitions */\r\n@font-face\r\n\t{font-family:\"Cambria Math\";\r\n\tpanose-1:2 4 5 3 5 4 6 3 2 4;}\r\n@font-face\r\n\t{font-family:Calibri;\r\n\tpanose-1:2 15 5 2 2 2 4 3 2 4;}\r\n/* Style Definitions */\r\np.MsoNormal, li.MsoNormal, div.MsoNormal\r\n\t{margin:0in;\r\n\tfont-size:12.0pt;\r\n\tfont-family:\"Calibri\",sans-serif;}\r\na:link, span.MsoHyperlink\r\n\t{mso-style-priority:99;\r\n\tcolor:#0563C1;\r\n\ttext-decoration:underline;}\r\nspan.EmailStyle19\r\n\t{mso-style-type:personal-reply;\r\n\tfont-family:\"Calibri\",sans-serif;\r\n\tcolor:windowtext;}\r\n.MsoChpDefault\r\n\t{mso-style-type:export-only;\r\n\tfont-size:10.0pt;}\r\n@page WordSection1\r\n\t{size:8.5in 11.0in;\r\n\tmargin:1.0in 1.0in 1.0in 1.0in;}\r\ndiv.WordSection1\r\n\t{page:WordSection1;}\r\n--></style>\r\n</head>\r\n<body lang=\"EN-US\" link=\"#0563C1\" vlink=\"#9*****F72\" style=\"word-wrap:break-word\">\r\n<div class=\"WordSection1\">\r\n<p class=\"MsoNormal\"><span style=\"font-size:11.0pt\">Cluster of 3<o:p></o:p></span></p>\r\n<p class=\"MsoNormal\"><span style=\"font-size:11.0pt\"><o:p>&nbsp;</o:p></span></p>\r\n<div style=\"border:none;border-top:solid #B5C4DF 1.0pt;padding:3.0pt 0in 0in 0in\">\r\n<p class=\"MsoNormal\"><b><span style=\"color:black\">From: </span></b><span style=\"color:black\">***** ***** &lt;*****@*****.com&gt;<br>\r\n<b>Date: </b>Sunday, August 22, 2021 at 10:26 PM<br>\r\n<b>To: </b>***** ***** &lt;*****@*****.com&gt;<br>\r\n<b>Subject: </b>Wherever I may Rome<o:p></o:p></span></p>\r\n</div>\r\n<div>\r\n<p class=\"MsoNormal\"><span style=\"font-size:11.0pt\"><o:p>&nbsp;</o:p></span></p>\r\n</div>\r\n<p class=\"MsoNormal\"><span style=\"font-size:11.0pt\"><a href=\"http://www.*****.net/*****.html\">www.*****.net/*****.html</a><o:p></o:p></span></p>\r\n<p class=\"MsoNormal\"><span style=\"font-size:11.0pt\"><o:p>&nbsp;</o:p></span></p>\r\n<p class=\"MsoNormal\"><span style=\"font-size:11.0pt\">That's it</span><o:p></o:p></p>\r\n</div>\r\n</body>\r\n</html>\r\n",
                "md5": "*****",
                "sha256": "*****",
                "match_priority": 2,
                "attachments_count": 12,
                "comments_count": 0,
                "rules_count": 3,
                "urls_count": 1,
                "tags": [],
                "categorization_tags": [
                    "R1"
                ],
                "processed_at": "2021-08-23T02:47:15.136Z",
                "created_at": "2021-08-23T02:40:21.585Z",
                "updated_at": "2021-08-23T02:48:48.100Z"
            },
            "relationships": {
                "assignee": {
                    "links": {
                        "self": "https://*****.phishmecloud.com/api/*****",
                        "related": "https://*****.phishmecloud.com/api/*****"
                    },
                    "data": null
                },
                "category": {
                    "links": {
                        "self": "https://*****.phishmecloud.com/api/*****",
                        "related": "https://*****.phishmecloud.com/api/*****"
                    },
                    "data": {
                        "type": "categories",
                        "id": "8"
                    }
                },
                "cluster": {
                    "links": {
                        "self": "https://*****.phishmecloud.com/api/*****",
                        "related": "https://*****.phishmecloud.com/api/*****"
                    },
                    "data": {
                        "type": "clusters",
                        "id": "352"
                    }
                },
                "reporter": {
                    "links": {
                        "self": "https://*****.phishmecloud.com/api/*****",
                        "related": "https://*****.phishmecloud.com/api/*****"
                    },
                    "data": {
                        "type": "reporters",
                        "id": "24"
                    }
                },
                "attachment_payloads": {
                    "links": {
                        "self": "https://*****.phishmecloud.com/api/*****",
                        "related": "https://*****.phishmecloud.com/api/*****"
                    }
                },
                "attachments": {
                    "links": {
                        "self": "https://*****.phishmecloud.com/api/*****",
                        "related": "https://*****.phishmecloud.com/api/*****"
                    }
                },
                "domains": {
                    "links": {
                        "self": "https://*****.phishmecloud.com/api/*****",
                        "related": "https://*****.phishmecloud.com/api/*****"
                    }
                },
                "headers": {
                    "links": {
                        "self": "https://*****.phishmecloud.com/api/*****",
                        "related": "https://*****.phishmecloud.com/api/*****"
                    }
                },
                "hostnames": {
                    "links": {
                        "self": "https://*****.phishmecloud.com/api/*****",
                        "related": "https://*****.phishmecloud.com/api/*****"
                    }
                },
                "urls": {
                    "links": {
                        "self": "https://*****.phishmecloud.com/api/*****",
                        "related": "https://*****.phishmecloud.com/api/*****"
                    }
                },
                "rules": {
                    "links": {
                        "self": "https://*****.phishmecloud.com/api/*****",
                        "related": "https://*****.phishmecloud.com/api/*****"
                    }
                },
                "threat_indicators": {
                    "links": {
                        "self": "https://*****.phishmecloud.com/api/*****",
                        "related": "https://*****.phishmecloud.com/api/*****"
                    }
                },
                "comments": {
                    "links": {
                        "self": "https://*****.phishmecloud.com/api/*****",
                        "related": "https://*****.phishmecloud.com/api/*****"
                    }
                }
            },
            "meta": {
                "risk_score_summary": {
                    "integrations": 9,
                    "vip": 5,
                    "reporter": 15,
                    "rules": 2
                }
            }
        }
    }
]
Key Fields

Common cyber security indicators such as unique IDs, file hash values, CVE numbers, IP addresses, etc., will be extracted from Raw Data as Key Fields.

The system stores these key fields in the path $.[playbookTask].outputData. You can use these key-value pairs as data points for playbook task inputs.

SAMPLE DATA

CODE
{
  "Ids": ["*****"],
  "Locations": ["Processed"],
  "RiskScores": [31],
  "FromAddresses": ["*****@*****.com"],
  "Subjects": [ "FW: Wherever I may Rome" ],
  "ReceivedAt": [ "2021-08-23 02:29:09" ],
  "RawHeaders": [
    "Date: Mon, 23 Aug 2021 02:40:21 +0000\r\nFrom: *****@*****.com\r\nTo: *****@*****.com\r\nMessage-ID: <*****@*****.com.mail>\r\nSubject: FW: Wherever I may Rome\r\nMime-Version: 1.0\r\nContent-Type: multipart/mixed;\r\n boundary=\"--==_mimepart_*****\"\r\nContent-Transfer-Encoding: 7bit"
   ],
   "TextBodies": [ "Cluster of 3\r\n\r\nFrom: ***** ***** <*****@*****.com>\r\nDate: Sunday, August 22, 2021 at 10:26 PM\r\nTo: ***** ***** <*****@*****.com>\r\nSubject: Wherever I may Rome\r\n\r\n*****.net/***<https://*****.net/***>\r\n\r\nThat's it\r\n" ],
   "MD5s": ["*****"],
   "SHA256s": ["*****"],
   "MatchPriorities": [2],
   "CreatedAt": ["2021-07-01T13:11:34.517Z"]
}
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
Result

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

SAMPLE DATA

data

{'id': '*****', 'type': 'reports', 'links': {'self': 'https://*****.phishmecloud.com/api/*****'}, 'attributes': {'location': 'Processed', 'risk_score': 31, 'from_address': '*****@*****.com', 'subject': 'FW: Wherever I may Rome', 'received_at': '2021-08-23T02:29:09.000Z', 'reported_at': '2021-08-23T02:29:09.000Z', 'raw_headers': 'Date: Mon, 23 Aug 2021 02:40:21 +0000\r\nFrom: *****@*****.com\r\nTo: *****@*****.com\r\nMessage-ID: <*****@*****.*****.com.mail>\r\nSubject: FW: Wherever I may Rome\r\nMime-Version: 1.0\r\nContent-Type: multipart/mixed;\r\n boundary="--==_mimepart_*****"\r\nContent-Transfer-Encoding: 7bit', 'text_body': "Cluster of 3\r\n\r\nFrom: ***** ***** <*****@*****.com>\r\nDate: Sunday, August 22, 2021 at 10:26 PM\r\nTo: ***** ***** <*****@*****.com>\r\nSubject: Wherever I may Rome\r\n\r\nwww.*****.net/*****.html<http://www.*****.net/*****.html>\r\n\r\nThat's it\r\n", 'html_body': '<html xmlns:o="urn:schemas-microsoft-com:office:office" xmlns:w="urn:schemas-microsoft-com:office:word" xmlns:m="http://*****.microsoft.com/*****" xmlns="http://www.w3.org/TR/REC-html40 ">\r\n<head>\r\n<meta http-equiv="Content-Type" content="text/html; charset=utf-8">\r\n<meta name="Generator" content="Microsoft Word 15 (filtered medium)">\r\n<style><!--\r\n/* Font Definitions */\r\n@font-face\r\n\t{font-family:"Cambria Math";\r\n\tpanose-1:2 4 5 3 5 4 6 3 2 4;}\r\n@font-face\r\n\t{font-family:Calibri;\r\n\tpanose-1:2 15 5 2 2 2 4 3 2 4;}\r\n/* Style Definitions */\r\np.MsoNormal, li.MsoNormal, div.MsoNormal\r\n\t{margin:0in;\r\n\tfont-size:12.0pt;\r\n\tfont-family:"Calibri",sans-serif;}\r\na:link, span.MsoHyperlink\r\n\t{mso-style-priority:99;\r\n\tcolor:#0563C1;\r\n\ttext-decoration:underline;}\r\nspan.EmailStyle19\r\n\t{mso-style-type:personal-reply;\r\n\tfont-family:"Calibri",sans-serif;\r\n\tcolor:windowtext;}\r\n.MsoChpDefault\r\n\t{mso-style-type:export-only;\r\n\tfont-size:10.0pt;}\r\n@page WordSection1\r\n\t{size:8.5in 11.0in;\r\n\tmargin:1.0in 1.0in 1.0in 1.0in;}\r\ndiv.WordSection1\r\n\t{page:WordSection1;}\r\n--></style>\r\n</head>\r\n<body lang="EN-US" link="#0563C1" vlink="#9*****F72" style="word-wrap:break-word">\r\n<div class="WordSection1">\r\n<p class="MsoNormal"><span style="font-size:11.0pt">Cluster of 3<o:p></o:p></span></p>\r\n<p class="MsoNormal"><span style="font-size:11.0pt"><o:p>&nbsp;</o:p></span></p>\r\n<div style="border:none;border-top:solid #B5C4DF 1.0pt;padding:3.0pt 0in 0in 0in">\r\n<p class="MsoNormal"><b><span style="color:black">From: </span></b><span style="color:black">***** ***** &lt;*****@*****.com&gt;<br>\r\n<b>Date: </b>Sunday, August 22, 2021 at 10:26 PM<br>\r\n<b>To: </b>***** ***** &lt;*****@*****.com&gt;<br>\r\n<b>Subject: </b>Wherever I may Rome<o:p></o:p></span></p>\r\n</div>\r\n<div>\r\n<p class="MsoNormal"><span style="font-size:11.0pt"><o:p>&nbsp;</o:p></span></p>\r\n</div>\r\n<p class="MsoNormal"><span style="font-size:11.0pt"><a href="http://www.*****.net/*****.html">www.*****.net/*****.html</a><o:p></o:p></span></p>\r\n<p class="MsoNormal"><span style="font-size:11.0pt"><o:p>&nbsp;</o:p></span></p>\r\n<p class="MsoNormal"><span style="font-size:11.0pt">That\'s it</span><o:p></o:p></p>\r\n</div>\r\n</body>\r\n</html>\r\n', 'md5': '*****', 'sha256': '*****', 'match_priority': 2, 'attachments_count': 12, 'comments_count': 0, 'rules_count': 3, 'urls_count': 1, 'tags': [], 'categorization_tags': ['R1'], 'processed_at': '2021-08-23T02:47:15.136Z', 'created_at': '2021-08-23T02:40:21.585Z', 'updated_at': '2021-08-23T02:48:48.100Z'}, 'relationships': {'assignee': {'links': {'self': 'https://*****.phishmecloud.com/api/*****', 'related': 'https://*****.phishmecloud.com/api/*****'}, 'data': None}, 'category': {'links': {'self': 'https://*****.phishmecloud.com/api/*****', 'related': 'https://*****.phishmecloud.com/api/*****'}, 'data': {'type': 'categories', 'id': '8'}}, 'cluster': {'links': {'self': 'https://*****.phishmecloud.com/api/*****', 'related': 'https://*****.phishmecloud.com/api/*****'}, 'data': {'type': 'clusters', 'id': '352'}}, 'reporter': {'links': {'self': 'https://*****.phishmecloud.com/api/*****', 'related': 'https://*****.phishmecloud.com/api/*****'}, 'data': {'type': 'reporters', 'id': '24'}}, 'attachment_payloads': {'links': {'self': 'https://*****.phishmecloud.com/api/*****', 'related': 'https://*****.phishmecloud.com/api/*****'}}, 'attachments': {'links': {'self': 'https://*****.phishmecloud.com/api/*****', 'related': 'https://*****.phishmecloud.com/api/*****'}}, 'domains': {'links': {'self': 'https://*****.phishmecloud.com/api/*****', 'related': 'https://*****.phishmecloud.com/api/*****'}}, 'headers': {'links': {'self': 'https://*****.phishmecloud.com/api/*****', 'related': 'https://*****.phishmecloud.com/api/*****'}}, 'hostnames': {'links': {'self': 'https://*****.phishmecloud.com/api/*****', 'related': 'https://*****.phishmecloud.com/api/*****'}}, 'urls': {'links': {'self': 'https://*****.phishmecloud.com/api/*****', 'related': 'https://*****.phishmecloud.com/api/*****'}}, 'rules': {'links': {'self': 'https://*****.phishmecloud.com/api/*****', 'related': 'https://*****.phishmecloud.com/api/*****'}}, 'threat_indicators': {'links': {'self': 'https://*****.phishmecloud.com/api/*****', 'related': 'https://*****.phishmecloud.com/api/*****'}}, 'comments': {'links': {'self': 'https://*****.phishmecloud.com/api/*****', 'related': 'https://*****.phishmecloud.com/api/*****'}}}, 'meta': {'risk_score_summary': {'integrations': 9, 'vip': 5, 'reporter': 15, 'rules': 2}}

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 Reports 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 Cofense Triage V2 portal. Refer to the HTTP Status Code Registry for details.

Status Code: 404.

Message

The raw data or captured key error message from the integration API server about the API request failure.

Message: The requested resource does not exist.

Error Sample Data

Get Reports failed.

Status Code: 404.

Message: The requested resource does not exist.

List Attachment Payloads

Lists the attachment payloads based on query criteria. Attachment payloads contain the MIME type and MD5 and SHA256 hash signatures of reported emails, along with the risk score assigned by Cofense Triage.

Input

Input Parameter

Required/Optional

Description

Example

MIME Type

Optional

The MIME type of the payload.

application/msword

Hash

Optional

The payload's hash, either SHA256 or MD5.

*****

Start Time

Optional

The start time to query, in UTC time.

2020-10-30 00:00

End Time

Optional

The end time to query, in UTC time.

2020-10-31 00:00

Page Number

Optional

The page number to return. The default value of this field is 1. The page size is 200.

1

Output

Raw Data

The primary response data from the API request.

SAMPLE DATA

CODE
{
    "data": [
        {
            "id": "*****",
            "type": "attachment_payloads",
            "links": {
                "self": "https://*****.phishmecloud.com/api/*****"
            },
            "attributes": {
                "mime_type": "application/msword; charset=binary",
                "md5": "*****",
                "sha256": "*****",
                "risk_score": null,
                "created_at": "2021-01-13T02:57:59.313Z",
                "updated_at": "2021-01-13T02:57:59.313Z"
            },
            "relationships": {
                "attachments": {
                    "links": {
                        "self": "https://*****.phishmecloud.com/api/*****",
                        "related": "https://*****.phishmecloud.com/api/*****"
                    }
                },
                "clusters": {
                    "links": {
                        "self": "https://*****.phishmecloud.com/api/*****",
                        "related": "https://*****.phishmecloud.com/api/*****"
                    }
                },
                "integration_submissions": {
                    "links": {
                        "self": "https://*****.phishmecloud.com/api/*****",
                        "related": "https://*****.phishmecloud.com/api/*****"
                    }
                },
                "reports": {
                    "links": {
                        "self": "https://*****.phishmecloud.com/api/*****",
                        "related": "https://*****.phishmecloud.com/api/*****"
                    }
                }
            }
        }
    ],
    "meta": {
        "record_count": 1,
        "page_count": 1
    },
    "links": {
        "first": "https://*****.phishmecloud.com/api/*****",
        "last": "https://*****.phishmecloud.com/api/*****"
    }
}
Key Fields

Common cyber security indicators such as unique IDs, file hash values, CVE numbers, IP addresses, etc., will be extracted from Raw Data as Key Fields.

The system stores these key fields in the path $.[playbookTask].outputData. You can use these key-value pairs as data points for playbook task inputs.

SAMPLE DATA

CODE
{
  "Ids": ["*****"],
  "MimeTypes": [ "application/msword; charset=binary" ],
  "MD5s": ["*****"],
  "SHA256s": ["*****"],
  "RiskScores": [0],
  "CreatedAt": [ "2021-07-01 13:22:34" ],
  "UpdatedAt": [ "2021-07-01 13:11:34" ]
}
Return Data

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

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

  • A connection issue with the integration

  • The API returned an error message

  • No response from the API

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

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

SAMPLE DATA

CODE
Successful
Result

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

SAMPLE DATA

data

  • {'id': '*****', 'type': 'attachment_payloads', 'links': {'self': 'https://*****.phishmecloud.com/api/*****'}, 'attributes': {'mime_type': 'application/msword; charset=binary', 'md5': '*****', 'sha256': '*****', 'risk_score': None, 'created_at': '2021-01-13T02:57:59.313Z', 'updated_at': '2021-01-13T02:57:59.313Z'}, 'relationships': {'attachments': {'links': {'self': 'https://*****.phishmecloud.com/api/*****', 'related': 'https://*****.phishmecloud.com/api/*****'}}, 'clusters': {'links': {'self': 'https://*****.phishmecloud.com/api/*****', 'related': 'https://*****.phishmecloud.com/api/*****'}}, 'integration_submissions': {'links': {'self': 'https://*****.phishmecloud.com/api/*****', 'related': 'https://*****.phishmecloud.com/api/*****'}}, 'reports': {'links': {'self': 'https://*****.phishmecloud.com/api/*****', 'related': 'https://*****.phishmecloud.com/api/*****'}}}}

meta

{'record_count': 1, 'page_count': 1}

links

{'first': 'https://*****.phishmecloud.com/api/*****', 'last': 'https://*****.phishmecloud.com/api/*****'}

Error Handling

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

The error tab contains the details responded from D3 SOAR or third-party API calls, including Failure Indicator, Status Code, and Message. This can help you locate the root cause of a command failure.

Parts in Error

Description

Example

Failure Indicator

Indicates the command failure that happened at a specific input and/or API call.

List Attachment Payloads 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 Cofense Triage V2 portal. Refer to the HTTP Status Code Registry for details.

Status Code: 401.

Message

The raw data or captured key error message from the integration API server about the API request failure.

Message: The access token is missing or is not valid.

Error Sample Data

List Attachment Payloads failed.

Status Code: 401.

Message: The access token is missing or is not valid.

List Comments

Comments allow users to communicate additional information about reports and threat indicators. List comments based on query criteria.

Input

Input Parameter

Required/Optional

Description

Example

Content

Optional

The content of the comment to query.

Phishing

Start Time

Optional

The start time to query, in UTC time.

2020-10-30 00:00

End Time

Optional

The end time to query, in UTC time.

2020-10-31 00:00

Page Number

Optional

The page number to return. The default value of this field is 1. The page size is 200.

1

Output

Raw Data

The primary response data from the API request.

SAMPLE DATA

CODE
{
    "data": [
        {
            "id": "*****",
            "type": "comments",
            "links": {
                "self": "https://*****.phishmecloud.com/api/*****"
            },
            "attributes": {
                "body_format": "text",
                "body": {
                    "data": {
                      "type": "comments",
                      "attributes": {
                        "body_format": "json",
                        "body": {
                          "type": "object",
                          "properties": {
                            "reported_time": {
                              "type": "Mar 31, 2021 at 14:40:45 UTC"
                            },
                            "srctag": {
                              "type": ["Harbor", "WigWag"]
                            },
                            "received_time": {
                              "type": "Mar 31, 2021 at 14:40:13 UTC"
                            },
                            "from": {
                              "type": "lsennett@contractor.net"
                            },
                            "reported_by": {
                              "type": "linda.nicholson@cofense.com"
                            },
                            "notes": {
                              "type": "The email reported to the Cofense Phishing Defense Center was analyzed and determined to be malicious. The email contains URLs and/or attachments which attempts to have the recipient download and execute the malware. If successful, the attacker could steal information from a system and exfiltrate the data to the threat actor. Please see the recommendations for how to respond to this threat. This ticket will be automatically closed after 72 hours."
                            },
                            "summary": {
                              "type": "Subscription-themed emails entice victims into calling an embedded phone number. Victims are then directed to download a Microsoft Excel spreadsheet containing malicious Office macros. The Office macro laden spreadsheets drop BazarBackdoor malware which then downloads additional BazarBackdoor files."
                            },
                            "malware_families": {
                              "type": "BazarBackdoor"
                            },
                            "phenotypes": {
                              "type": ""
                            },
                            "message_id": {
                              "type": "trinity-73b5ec3e-3efa-4999-a6bf-528fe2f9deed-1617201608494@3c-app-mailcom-lxa07"
                            },
                            "reply_to": {
                              "type": ""
                            },
                            "report_url": {
                              "type": "https://reltest2.phishmecloud.com/reports/36229"
                            },
                            "escalation_type": {
                              "type": ""
                            },
                            "stage_1_iocs": {
                              "type": "object",
                              "properties": {
                                "files": {
                                  "type": "subscription.xlsb"
                                },
                                "infection_ips": {
                                  "type": "array",
                                  "items": {
                                    "type": "string"
                                  }
                                },
                                "infection_urls": {
                                  "type": "array",
                                  "items": {
                                    "type": ["hxxps://inetservice.net/requested.php", "hxxps://icarpservicing.org/unsubscribe.html"]
                                  }
                                }
                              }
                            },
                            "brands": {
                              "type": "array",
                              "items": {
                                "type": "string"
                              }
                            },
                            "vision_results": {
                              "type": "object",
                              "properties": {
                                "results_id": "61",
                                "query_created": {
                                  "type": "Apr 2, 2021 at 14:37:35 UTC"
                                },
                                "messages_removed": "0",
                                "messages_found": "2"
                              }
                            },
                            "subject": {
                              "type": "Extend your free trial"
                            },
                            "sent_to": {
                              "type": "linda.nicholson@cofense.com"
                            },
                            "stage_2_iocs": {
                              "type": "object",
                              "properties": {
                                "files": {
                                  "type": "172.dll"
                                },
                                "md5": {
                                  "type": "af18cd9e099e6e7c56bd5a07502b1f0z"
                                },
                                "size": {
                                  "type": "37,888"
                                },
                                "payload_ips": {
                                  "type": "array",
                                  "items": {
                                    "type": "*****.220.162.4"
                                  }
                                },
                                "payload_urls": {
                                  "type": "array",
                                  "items": {
                                    "type": "hxxp://call2.xyz/campo/j1/j1"
                                  }
                                },
                                "c2_ips": {
                                  "type": "33.162.31.92"
                                },
                                "c2_urls": {
                                  "type": ["hxxps://gopigs.xyz/campo/u/u", "hxxp://gainme.xyz/campo/t/t"]
                                }
                              }
                            },
                            "report_id": {
                              "type": "36229"
                            }
                          }
                        },
                        "tags": ["stage_2_iocs", "malicious"]
                      },
                      "relationships": {
                        "commentable": {
                          "data": {
                            "id": "36229",
                            "type": "reports"
                          }
                        }
                      }
                    }
                  }
                "tags": [
                    "PDC_Escalation_Ticket"
                ],
                "created_at": "2021-07-07T21:22:01.742Z",
                "updated_at": "2021-07-07T21:22:01.742Z"
            },
            "relationships": {
                "commentable": {
                    "links": {
                        "self": "https://*****.phishmecloud.com/api/*****",
                        "related": "https://*****.phishmecloud.com/api/*****"
                    },
                    "data": {
                        "type": "reports",
                        "id": "*****"
                    }
                },
                "owner": {
                    "links": {
                        "self": "https://*****.phishmecloud.com/api/*****",
                        "related": "https://*****.phishmecloud.com/api/*****"
                    },
                    "data": {
                        "type": "operators",
                        "id": "*****"
                    }
                }
            }
        },
        {
            "id": "*****",
            "type": "comments",
            "links": {
                "self": "https://*****.phishmecloud.com/api/*****"
            },
            "attributes": {
                "body_format": "text",
                "body": "            \"type\": \"The email reported to the Cofense Phishing Defense Center was analyzed and determined to be malicious. The email contains URLs and/or attachments which attempts to have the recipient download and execute the malware. If successful, the attacker could steal information from a system and exfiltrate the data to the threat actor. Please see the recommendations for how to respond to this threat. This ticket will be automatically closed after 72 hours.\"\r\n          },\r\n          \"summary\": {\r\n            \"type\": \"Subscription-themed emails entice victims into calling an embedded phone number. Victims are then directed to download a Microsoft Excel spreadsheet containing malicious Office macros. The Office macro laden spreadsheets drop BazarBackdoor malware which then downloads additional BazarBackdoor files.\"\r\n          },\r\n          \"malware_families\": {\r\n            \"type\": \"BazarBackdoor\"\r\n          },\r\n          \"phenotypes\": {\r\n             \"type\": \" \"\r\n",
                "tags": [
                    "stage_2_iocs",
                    "malicious"
                ],
                "created_at": "2021-07-06T13:43:42.608Z",
                "updated_at": "2021-07-06T13:43:42.608Z"
            },
            "relationships": {
                "commentable": {
                    "links": {
                        "self": "https://*****.phishmecloud.com/api/*****",
                        "related": "https://*****.phishmecloud.com/api/*****"
                    },
                    "data": {
                        "type": "reports",
                        "id": "*****"
                    }
                },
                "owner": {
                    "links": {
                        "self": "https://*****.phishmecloud.com/api/*****",
                        "related": "https://*****.phishmecloud.com/api/*****"
                    },
                    "data": {
                        "type": "operators",
                        "id": "*****"
                    }
                }
            }
        }
    ],
    "meta": {
        "record_count": 2,
        "page_count": 1
    },
    "links": {
        "first": "https://*****.phishmecloud.com/api/*****",
        "last": "https://*****.phishmecloud.com/api/*****"
    }
}
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
{
  "CommentIDs": ["*****"],
  "BodyFormats": ["text"],
  "Bodies": [
    {
      "BodyFormats": [
        {
          "type": "The email reported to the Cofense Phishing Defense Center was analyzed and determined to be malicious. The email contains URLs and/or attachments which attempts to have the recipient download and execute the malware. If successful, the attacker could steal information from a system and exfiltrate the data to the threat actor. Please see the recommendations for how to respond to this threat. This ticket will be automatically closed after 72 hours."
        }
      ],
      "summary": {
        "type": "Subscription-themed emails entice victims into calling an embedded phone number. Victims are then directed to download a Microsoft Excel spreadsheet containing malicious Office macros. The Office macro laden spreadsheets drop BazarBackdoor malware which then downloads additional BazarBackdoor files."
      },
      "malware_families": {
        "type": "BazarBackdoor"
      },
      "phenotypes": {
        "type": ""
      }
    }
  ],
  "CreatedAt": ["2021-07-01T13:22:34.517Z"],
  "UpdatedAt": ["2021-07-01T13:11:34.517Z"]
}
Return Data

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

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

  • A connection issue with the integration

  • The API returned an error message

  • No response from the API

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

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

SAMPLE DATA

CODE
Successful
Result

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

SAMPLE DATA

data

  • {'id': '*****', 'type': 'comments', 'links': {'self': 'https://*****.phishmecloud.com/api/*****'}, 'attributes': {'body_format': 'text', 'body': '{\r\n "data": {\r\n "type": "comments",\r\n "attributes": {\r\n "body_format":"json",\r\n "body":{\r\n "type": "object",\r\n "properties": {\r\n "reported_time": {\r\n "type": "Mar 31, 2021 at 14:40:45 UTC"\r\n },\r\n "srctag": {\r\n "type": ["Harbor", "WigWag"]\r\n },\r\n "received_time": {\r\n "type": "Mar 31, 2021 at 14:40:13 UTC"\r\n },\r\n "from": {\r\n "type": "lsennett@contractor.net"\r\n },\r\n "reported_by": {\r\n "type": "linda.nicholson@cofense.com"\r\n },\r\n "notes": {\r\n "type": "The email reported to the Cofense Phishing Defense Center was analyzed and determined to be malicious. The email contains URLs and/or attachments which attempts to have the recipient download and execute the malware. If successful, the attacker could steal information from a system and exfiltrate the data to the threat actor. Please see the recommendations for how to respond to this threat. This ticket will be automatically closed after 72 hours."\r\n },\r\n "summary": {\r\n "type": "Subscription-themed emails entice victims into calling an embedded phone number. Victims are then directed to download a Microsoft Excel spreadsheet containing malicious Office macros. The Office macro laden spreadsheets drop BazarBackdoor malware which then downloads additional BazarBackdoor files."\r\n },\r\n "malware_families": {\r\n "type": "BazarBackdoor"\r\n },\r\n "phenotypes": {\r\n "type": " "\r\n },\r\n "message_id": {\r\n "type": "trinity-73b5ec3e-3efa-4999-a6bf-528fe2f9deed-1617201608494@3c-app-mailcom-lxa07"\r\n },\r\n "reply_to": {\r\n "type": " "\r\n },\r\n "report_url": {\r\n "type": "https://reltest2.phishmecloud.com/reports/36229"\r\n },\r\n "escalation_type": {\r\n "type": " "\r\n },\r\n "stage_1_iocs": {\r\n "type": "object",\r\n "properties": {\r\n "files": {\r\n "type": "subscription.xlsb"\r\n },\r\n "infection_ips": {\r\n "type": "array",\r\n "items": {\r\n "type": "string"\r\n }\r\n },\r\n "infection_urls": {\r\n "type": "array",\r\n "items": {\r\n "type": ["hxxps://inetservice.net/requested.php", "hxxps://icarpservicing.org/unsubscribe.html"]\r\n }\r\n }\r\n }\r\n },\r\n "brands": {\r\n "type": "array",\r\n "items": {\r\n "type": "string"\r\n }\r\n },\r\n "vision_results": {\r\n "type": "object",\r\n "properties": {\r\n "results_id": "61",\r\n "query_created": {\r\n "type": "Apr 2, 2021 at 14:37:35 UTC"\r\n },\r\n "messages_removed": "0",\r\n "messages_found": "2"\r\n }\r\n },\r\n "subject": {\r\n "type": "Extend your free trial"\r\n },\r\n "sent_to": {\r\n "type": "linda.nicholson@cofense.com"\r\n },\r\n "stage_2_iocs": {\r\n "type": "object",\r\n "properties": {\r\n "files": {\r\n "type": "172.dll"\r\n },\r\n "md5":{\r\n "type": "af18cd9e099e6e7c56bd5a07502b1f0z"\r\n },\r\n "size":{\r\n "type": "37,888"\r\n },\r\n "payload_ips": {\r\n "type": "array",\r\n "items": {\r\n "type": "*****.220.162.4"\r\n }\r\n },\r\n "payload_urls": {\r\n "type": "array",\r\n "items": {\r\n "type": "hxxp://call2.xyz/campo/j1/j1"\r\n }\r\n },\r\n "c2_ips": {\r\n "type": "33.162.31.92"\r\n },\r\n "c2_urls": {\r\n "type": ["hxxps://gopigs.xyz/campo/u/u", "hxxp://gainme.xyz/campo/t/t"]\r\n }\r\n }\r\n },\r\n "report_id": {\r\n "type": "36229"\r\n }\r\n }\r\n },\r\n "tags": [ "stage_2_iocs", "malicious"]\r\n },\r\n "relationships": {\r\n "commentable": {\r\n "data": {\r\n "id": "36229",\r\n "type": "reports"\r\n }\r\n }\r\n }\r\n }\r\n}', 'tags': ['PDC_Escalation_Ticket'], 'created_at': '2021-07-07T21:22:01.742Z', 'updated_at': '2021-07-07T21:22:01.742Z'}, 'relationships': {'commentable': {'links': {'self': 'https://*****.phishmecloud.com/api/*****', 'related': 'https://*****.phishmecloud.com/api/*****'}, 'data': {'type': 'reports', 'id': '*****'}}, 'owner': {'links': {'self': 'https://*****.phishmecloud.com/api/*****', 'related': 'https://*****.phishmecloud.com/api/*****'}, 'data': {'type': 'operators', 'id': '2'}}}}

  • {'id': '*****', 'type': 'comments', 'links': {'self': 'https://*****.phishmecloud.com/api/*****'}, 'attributes': {'body_format': 'text', 'body': ' "type": "The email reported to the Cofense Phishing Defense Center was analyzed and determined to be malicious. The email contains URLs and/or attachments which attempts to have the recipient download and execute the malware. If successful, the attacker could steal information from a system and exfiltrate the data to the threat actor. Please see the recommendations for how to respond to this threat. This ticket will be automatically closed after 72 hours."\r\n },\r\n "summary": {\r\n "type": "Subscription-themed emails entice victims into calling an embedded phone number. Victims are then directed to download a Microsoft Excel spreadsheet containing malicious Office macros. The Office macro laden spreadsheets drop BazarBackdoor malware which then downloads additional BazarBackdoor files."\r\n },\r\n "malware_families": {\r\n "type": "BazarBackdoor"\r\n },\r\n "phenotypes": {\r\n "type": " "\r\n', 'tags': ['stage_2_iocs', 'malicious'], 'created_at': '2021-07-06T13:43:42.608Z', 'updated_at': '2021-07-06T13:43:42.608Z'}, 'relationships': {'commentable': {'links': {'self': 'https://*****.phishmecloud.com/api/*****', 'related': 'https://*****.phishmecloud.com/api/*****'}, 'data': {'type': 'reports', 'id': '889'}}, 'owner': {'links': {'self': 'https://*****.phishmecloud.com/api/*****', 'related': 'https://*****.phishmecloud.com/api/*****'}, 'data': {'type': 'operators', 'id': '2'}}}}

meta

{'record_count': 2, 'page_count': 1}

links

{'first': 'https://*****.phishmecloud.com/api/*****', 'last': 'https://*****.phishmecloud.com/api/*****'}

Output Type

Description

Return Data Type

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.

String

Raw Data

The primary response data from the API request.

JSON

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.

JSON

Result

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

HTML

Error Handling

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

The error tab contains the details responded from D3 SOAR or third-party API calls, including Failure Indicator, Status Code, and Message. This can help you locate the root cause of a command failure.

Parts in Error

Description

Example

Failure Indicator

Indicates the command failure that happened at a specific input and/or API call.

List 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 Cofense Triage V2 portal. Refer to the HTTP Status Code Registry for details.

Status Code: 401.

Message

The raw data or captured key error message from the integration API server about the API request failure.

Message: The access token is missing or is not valid.

Error Sample Data

List Comments failed.

Status Code: 401.

Message: The access token is missing or is not valid.

List Domains

For reported emails that contain URLs, Cofense Triage captures the domain port of the URL and assigns it a risk score. List the Domains according to query criteria.

Input

Input Parameter

Required/Optional

Description

Example

Start Time

Optional

The start time to query, in UTC time.

2020-10-30 00:00

End Time

Optional

The end time to query, in UTC time.

2020-10-31 00:00

Page Number

Optional

The page number to return. The default value of this field is 1. The page size is 200.

1

Output

Output Type

Description

Return Data Type

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.

String

Raw Data

The primary response data from the API request.

JSON

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.

JSON

Result

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

HTML

Error Handling

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

The error tab contains the details responded from D3 SOAR or third-party API calls, including Failure Indicator, Status Code, and Message. This can help you locate the root cause of a command failure.

Parts in Error

Description

Example

Failure Indicator

Indicates the command failure that happened at a specific input and/or API call.

List Domains 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 Cofense Triage V2 portal. Refer to the HTTP Status Code Registry for details.

Status Code: 401.

Message

The raw data or captured key error message from the integration API server about the API request failure.

Message: The access token is missing or is not valid.

Error Sample Data

List Domains failed.

Status Code: 401.

Message: The access token is missing or is not valid.

List Threat Indicators

Retrieves a list of threat indicators with details based on the specified criteria(s). Threat indicators identify the threat level of an email's subject, sender, domains, URLs, and MD5 and SHA256 attachment hash signatures.

Input

Input Parameter

Required/Optional

Description

Example

Threat Type

Optional

The type of threat to query.

MD5

Threat Value

Optional

The threat value to query.

5d41402abc4b2a76b9719d911017c592

Threat Level

Optional

The threat level to query.

Malicious

Start Time

Optional

The start time to query, in UTC time.

2020-10-30 00:00

End Time

Optional

The end time to query, in UTC time.

2020-10-31 00:00

Page Number

Optional

The page number to return. The default value of this field is 1. The page size is 200.

1

Output

Output Type

Description

Return Data Type

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.

String

Raw Data

The primary response data from the API request.

JSON

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.

JSON

Result

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

HTML

Error Handling

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

The error tab contains the details responded from D3 SOAR or third-party API calls, including Failure Indicator, Status Code, and Message. This can help you locate the root cause of a command failure.

Parts in Error

Description

Example

Failure Indicator

Indicates the command failure that happened at a specific input and/or API call.

List Threat Indicators failed.

Status Code

The response code issued by the third-party API server or the D3 SOAR system that can be used to locate the corresponding error category. For example, if the returned status code is 401, the selected connection is unauthorized to run the command. The user or system support would need to check the permission setting in the Cofense Triage V2 portal. Refer to the HTTP Status Code Registry for details.

Status Code: 401.

Message

The raw data or captured key error message from the integration API server about the API request failure.

Message: The access token is missing or is not valid.

Error Sample Data

List Threat Indicators failed.

Status Code: 401.

Message: The access token is missing or is not valid.

List URLs

Lists the URLs based on query criteria for reported emails containing URLs. Cofense Triage captures each URL and assigns it a risk score.

Input

Input Parameter

Required/Optional

Description

Example

Start Time

Optional

The start time to query, in UTC time.

2020-10-30 00:00

End Time

Optional

The end time to query, in UTC time.

2020-10-31 00:00

Page Number

Optional

The page number to return. The default value of this field is 1. The page limit is set to 200 records. If the number of returned records exceeds 200, you must specify the page number. For example, 2 indicates the second page, while 3 indicates the third page.

1

Output

Output Type

Description

Return Data Type

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.

String

Raw Data

The primary response data from the API request.

JSON

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.

JSON

Result

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

HTML

Error Handling

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

The error tab contains the details responded from D3 SOAR or third-party API calls, including Failure Indicator, Status Code, and Message. This can help you locate the root cause of a command failure.

Parts in Error

Description

Example

Failure Indicator

Indicates the command failure that happened at a specific input and/or API call.

List 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 Cofense Triage V2 portal. Refer to the HTTP Status Code Registry for details.

Status Code: 401.

Message

The raw data or captured key error message from the integration API server about the API request failure.

Message: The access token is missing or is not valid.

Error Sample Data

List URLs failed.

Status Code: 401.

Message: The access token is missing or is not valid.

Retrieve Related Resources

Retrieves the specified relationship of a resource with a given resource ID. If no relationship is specified, return the related information of the resource.

Input

Input Parameter

Required/Optional

Description

Example

Resource Type

Required

The type of the resource.

Attachment Payloads

Resource ID

Required

The ID of the resource.

*****

Relationship Name

Optional

The name of the relationship to retrieve. If not specified, all relationship names will be returned in the result.

Attachments

Output

Output Type

Description

Return Data Type

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.

String

Raw Data

The primary response data from the API request.

JSON

Result

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

HTML

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.

Retrieve Related Resources 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 Cofense Triage V2 portal. Refer to the HTTP Status Code Registry for details.

Status Code: 404.

Message

The raw data or captured key error message from the integration API server about the API request failure.

Message:The requested resource does not exist.

Error Sample Data

Retrieve Related Resources failed.

Status Code: 404.

Message: The requested resource does not exist.

Update Report Tags

Updates the tag of the specified report.

READER NOTE

The parameter Report IDs is required to run this command.

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

Input

Input Parameter

Required/Optional

Description

Example

Report IDs

Required

The report IDs to be tagged. Report ID can be obtained using the Fetch Event command.

[ "*****" ]

Tags

Required

The tag names. Delimit them by a comma if multiple tags are needed.

Tag1,tag2

Output

Output Type

Description

Return Data Type

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.

String

Raw Data

The primary response data from the API request.

JSON

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.

JSON

Result

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

HTML

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.

Update Report Tags 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 Cofense Triage V2 portal. Refer to the HTTP Status Code Registry for details.

Status Code: 404.

Message

The raw data or captured key error message from the integration API server about the API request failure.

Message: The requested resource does not exist.

Error Sample Data

Update Report Tags failed.

Status Code: 404.

Message: The requested resource does not exist.

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

Output Type

Description

Return Data Type

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.

String

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 Cofense Triage V2 portal. Refer to the HTTP Status Code Registry for details.

Status Code: 401.

Message

The raw data or captured key error message from the integration API server about the API request failure.

Message: The access token is missing or is not valid.

Error Sample Data

Test Connection failed. Failed to check the connector.

Status Code: 401.

Message: The access token is missing or is not valid.


Appendix

D3 SOAR and Integration Deployment Options

Option I: D3 SaaS = Integration On-Premises/Private-Cloud

READER NOTE

A D3 proxy server with a SOAR agent is required to work with integrations located at a client’s internal network. Please refer to the D3 VSOC 14.0 Proxy Agent Hardware Software Requirements installation Guide for instructions to configure a proxy agent.

Option II: D3 SaaS = Integration On-Cloud

Option III: D3 On-Premises = Integration On-Premises
Option IV: D3 On-Premises = Integration On-Cloud

READER NOTE

Specific internet proxy settings may be required subject to the firewall policies under a client’s environment. Please refer to session 3.2 in the D3 VSOC 14.0 Proxy Agent Hardware Software Requirements installation Guide for details.

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.