Checkpoint Avanan

LAST UPDATED: OCT 31, 2024

Overview

Avanan is an Enterprise Solution for Cloud Email and Collaboration Security. Avanan uses advanced AI to protect cloud email and collaboration suites from cyber attacks.

D3's integration with Avanan's latest REST API to automate the technical and business use cases. D3 provided the ability not only to ingest the security events and take action on them but also provides the ability to list/create/update/delete the exceptions.

D3 SOAR is providing REST operations to function with Checkpoint Avanan.

Checkpoint Avanan is available for use in:

D3 SOAR	V15.4.77.0+
Category	Other
Deployment Options	Option II, Option IV

Known Limitations

An API rate limit is applied to restrict the number of requests. To learn about the rate limit restrictions for Checkpoint Avanan, please see API Call Restrictions | Mimecast.

A limit can be applied to the number of licensed users for a tenant. To learn more about license managing, please see License Management - Restricting License Usage.

Connection

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

Parameter	Description	Example
Region	The Server region for the integration.	USA
Application ID	The Application ID to authenticate the API connection.	myapp29
Secret Key	The secret key to authenticate the API connection.	2xxxxxxF-5D9C-4xx0-9xxB-63xxxxF5xxxx8
API Version	The version of the API to use for the connection.	v1.0

Configuring Checkpoint Avanan to Work with D3 SOAR

An Application ID and Secret Key are required to establish the connection to D3 SOAR. These can be obtained by reaching out to Avanan's support team at the following link, and are provided upon signup: https://www.avanan.com/#supportModal

See https://www.avanan.com/msp-docs/settings-user-management for information on user management.

Configuring D3 SOAR to Work with Checkpoint Avanan

Log in to D3 SOAR.
Find the Checkpoint Avanan integration.
1. Navigate to Configuration on the top header menu.
2. Click on the Integration icon on the left sidebar.
3. Type Checkpoint Avanan in the search box to find the integration, then click it to select it.
4. Click + Connection, on the right side of the Connections section. A new connection window will appear.
Configure the following fields to create a connection to Checkpoint Avanan.
1. Connection Name: The desired name for the connection.
2. Site: Specifies the site to use the integration connection. Use the drop-down menu to select the site. The Share to Internal Sites option enables all sites defined as internal sites to use the connection. Selecting a specific site will only enable that site to use the connection.
3. Recipient site for events from connections Shared to Internal Sites: This field appears if you selected Share to Internal Sites for Site to let you select the internal site to deploy the integration connection.
4. Agent Name (Optional): Specifies the proxy agent required to build the connection. Use the dropdown menu to select the proxy agent from a list of previously configured proxy agents.
5. Description (Optional): Add your desired description for the connection.
6. Tenant (Optional): When configuring the connection from a master tenant site, you have the option to choose the specific tenant sites you want to share the connection with. Once you enable this setting, you can filter and select the desired tenant sites from the dropdowns to share the connection.
7. Configure User Permissions: Defines which users have access to the connection.
8. Active: Check the tick box to ensure the connection is available for use.
9. System: This section contains the parameters defined specifically for the integration. These parameters must be configured to create the integration connection.
  1. Select your Region.
  2. Copy the Application ID from the Checkpoint Avanan platform. Refer to Configuring Checkpoint Avanan to Work with D3 SOAR.
  3. Copy the Secret Key from the Checkpoint Avanan platform. Refer to Configuring Checkpoint Avanan to Work with D3 SOAR.
  4. Input the API Version. The default value is v1.0.
10. Connection Health Check: Updates the connection status you have created. A connection health check is done by scheduling the Test Connection command of this integration. This can only be done when the connection is active.
  To set up a connection health check, check the Connection Health Check tickbox. You can customize the interval (minutes) for scheduling the health check. An email notification can be set up after a specified number of failed connection attempts.
11. Enable Password Vault: An optional feature that allows users to take the stored credentials from their own password vault. Please refer to the password vault connection guide if needed.
Test the connection.
1. Click Test Connection to verify the account credentials and network connection. If the Test Connection Passed alert window appears, the test connection is successful. You will see Passed with a green checkmark appear beside the Test Connection button. If the test connection fails, please check your connection parameters and try again.
2. Click OK to close the alert window.
3. Click + Add to create and add the configured connection.

Commands

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

Note for Time-related parameters

The input format of time-related parameters may vary based on your account settings. As a result, the sample data provided in our commands is different from what you see. To set your preferred time format, follow these steps:

Navigate to Configuration > Application Settings. Select Date/Time Format.
Choose your desired date and time format.

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

Create Exception

Creates an exception.

READER NOTE

When creating a Whitelist exception, Sender Email, Sender Name, Recipient, Sender Domain and Subject are required parameters.

Input

Input Parameter	Required/Optional	Description	Example
Exception Type	Required	The type of Exception to be created.	Black List
Attachment MD5 Hash	Optional	The MD5 hash value of the attachment.	***
Sender Email	Optional	The email address of the sender.	test@example.com
Sender Name	Optional	The name of the sender.	user3a
Recipient	Optional	The email address of the recipient.	test@example.com
Sender Client IP	Optional	The client IP address of the sender.	10.0.0.123
Sender Domain	Optional	The domain name of the sender.	example.com
Sender IP	Optional	The IP address of the sender.	199.199.199.195
Link Domains	Optional	The linked domain names.	phishing.com
Subject	Optional	The subject for the exception.	testSubject
Comment	Optional	The comment for the exception.	testBlackList
Action Needed	Optional	The action to be taken. The available options are Spam and Phishing. Please note, this parameter is valid only when the Exception Type is Black List. Available options are Spam and Phishing.	Spam
Subject Matching	Optional	The Subject matching type. The available options are Contains or Match.	Contains
Link Domain Matching	Optional	The Link Domain matching type. The available options are Contains or Match.	Contains
Sender Name Matching	Optional	The Sender Name matching type. The available options are Contains or Match.	Contains
Sender Domain Matching	Optional	The Sender Domain matching type. The available options are Contains, Match or Ends With.	Ends With
Recipient Matching	Optional	The Recipient Email address matching type. The available options are Contains or Match.	Contains

Output

Raw Data

The primary response data from the API request.

SAMPLE DATA

JSON

{
    "responseEnvelope": {
        "requestId": "***-***-***-***-***",
        "responseCode": 200,
        "responseText": "",
        "additionalText": "",
        "recordsNumber": 1,
        "scrollId": ""
    },
    "responseData": []
}

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

requestId	1234
responseCode	200
responseText
additionalText
recordsNumber	0
scrollId

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

Error Sample Data

Create Exception failed.

Status Code: 403.

Message: Forbidden.

Delete Exceptions

Deletes specified exceptions. The exceptions to be deleted must be of the same exception type, White List or Black List.

READER NOTE

Exception Entity ID is a required parameter to run this command.

Run the List Exceptions command to obtain Exception Entity ID. Exception Entity IDs can be found in the returned raw data at the path $.responseData[*].entityId.

Input

Input Parameter	Required/Optional	Description	Example
Exception Type	Required	The type of the Exception to be deleted. The available options are White List and Black List.	Black List
Exception Entity IDs	Required	The IDs of the Exceptions to be deleted. Exception IDs can be obtained using the List Exceptions command.	[ "***" ]

Output

Raw Data

The primary response data from the API request.

SAMPLE DATA

JSON

[
    {
        "excId": "***",
        "responseEnvelope": {
            "requestId": "***-***-***-***-***",
            "responseCode": 204,
            "responseText": "",
            "additionalText": "",
            "recordsNumber": 0,
            "scrollId": ""
        },
        "responseData": []
    }
]

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

requestId	1234
responseCode	200
responseText
additionalText
recordsNumber	0
scrollId

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

Error Sample Data

Delete Exceptions failed.

Status Code: 403.

Message: Forbidden.

Fetch Event

Returns Events from the platform based on specified criteria.

READER NOTE

Scopes and Event IDs are optional parameters to run this command.

Run the List Scopes command to obtain Scopes. Scopes can be found from the returned raw data at the path $.responseData[*].
You should already have the Event IDs on hand if you want to input this parameter. If you don't, Event IDs can be obtained by running the Fetch Event command and leaving this parameter empty. Event IDs can be found from the returned raw data at the path $.responseData[*].eventId.

Input

Input Parameter	Required/Optional	Description	Example
Start Time	Required	The start time of the time range to filter the events in UTC time.	2022-12-01 00:00
End Time	Optional	The end time of the time range to filter the events in UTC time.	2022-12-02 00:00
Number of Event(s) Fetched	Optional	The maximum number of events to return. When the value is 0, a negative number, or not specified, the command will return all events in the given time range. Note: If the Number of Event(s) Fetched entered is too large, it might affect system performance when returning a large number of events. Please set a suitable value to limit the maximum number of events to return.	50
Scopes	Optional	The list of scopes that will be used to retrieve the results. Scopes can be obtained by running the List Scopes command.	[ "mt-prod-3:***" ]
Event IDs	Optional	The list of event IDs that will be used to retrieve the results.	[ "***" ]
Event Types	Optional	The list of event types that will be used to filter the results. The available types are "phishing", "malware", "suspicious malware", "dlp", "anomaly", "shadow_it", "malicious_url_click", "malicious_url", "alert".	[ "phishing", "malware", "suspicious malware", "dlp", "anomaly", "shadow_it", "malicious_url_click", "malicious_url", "alert" ]
Event States	Optional	The list of event states that will be used to filter the results. The available states are new, detected, pending, remediated, dismissed and exception.	[ "new" ]
Severities	Optional	The list of severities that will be used to filter the results. The available severities are lowest, low, medium, high and critical.	[ "high" ]
Required SaaS	Optional	The list of required SaaS names that will be used to filter the results. The available values are office365_emails, office365_onedrive, office365_sharepoint, sharefile, slack, ms_teams and google_mail.	[ "office365_emails" ]
Confidence Indicator	Optional	The confidence indicator to filter the results. For example "malicious".	malicious
Description	Optional	The string in the event description to filter the results.	test@example.com
Tolerance Scope (Minutes)	Optional	The tolerance scope in minutes for the query to retrieve events between start and end time to avoid data loss. The event will be fetched between {Start Time - Tolerance Scope, End Time}.	10

Output

Raw Data

The primary response data from the API request.

SAMPLE DATA

JSON

{
    "responseEnvelope": {
        "responseCode": 0,
        "responseTest": "Success",
        "additionalText": "",
        "recordsNumber": 1,
        "totalRecordsNumber": 1,
        "scrollId": "***"
    },
    "responseData": [
        {
            "eventId": "***",
            "customerId": "us:customername",
            "saas": "office365_emails",
            "entityId": "***",
            "state": "dismissed",
            "type": "dlp",
            "confidenceIndicator": "malicious",
            "eventCreated": "2020-07-24T20:58:27.073355+00:00",
            "severity": "Low",
            "data": "",
            "description": "DLP Engine has detected a leak in 'please see my credit data' from user@customer.com",
            "additionalData": "some links here and additional parameters",
            "availableEventActions": [
                {
                    "actionName": "dismiss",
                    "actionParameter": {
                        "eventId": "***"
                    }
                },
                {
                    "actionName": "severityChange",
                    "actionParameter": {
                        "newSeverity": "Low"
                    }
                },
                {
                    "actionName": "severityChange",
                    "actionParameter": {
                        "newSeverity": "Medium"
                    }
                },
                {
                    "actionName": "severityChange",
                    "actionParameter": {
                        "newSeverity": "High"
                    }
                },
                {
                    "actionName": "severityChange",
                    "actionParameter": {
                        "newSeverity": "Highest"
                    }
                }
            ]
        }
    ]
}

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

{
    "EventIDs": "\"[ \\\"***\\\", \\\"***\\\" ]\"",
    "Severities": "\"[ \\\"Low\\\", \\\"High\\\" ]\""
}

Return Data

Indicates one of the possible command execution states: Successful, Successful with No Event Data, or Failed.

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

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

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

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

SAMPLE DATA

CODE

Successful

Result

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

SAMPLE DATA

Start Time (UTC)	2023-04-06T00:00:00.000Z
End Time (UTC)	2023-04-07T00:00:00.000Z
EventsCount	1

Fetch Event Field Mapping

Please note that Fetch Event commands require event field mapping. Field mapping plays a key role in the data normalization process part of the event pipeline. Field mapping converts the original data fields from the different providers to the D3 fields which are standardized by the D3 Model. Please refer to Event and Incident Intake Field Mapping for details.

If you require a custom field mapping, click + Add Field to add a custom field mapping. You may also remove built-in field mappings by clicking x. Please note that two underscore characters will automatically prefix the defined Field Name as the System Name for a custom field mapping. Additionally, if an input Field Name contains any spaces, they will automatically be replaced with underscores for the corresponding System Name.

As a system integration, the Checkpoint Avanan 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., $.responseData) that is used to extract a batch of events from the response raw data. Click Edit Main JSON Path to view the “Main Event JSON Path”.
- Main Event JSON Path: $.responseData
  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 responseData. The child node denoting the Unique Event Key field would be eventId. Putting it together, the JSON Path expression to extract the Unique Event Key is $.responseData.eventId.

The pre-configured field mappings are detailed below:

Field Name	Source Field
Unique Event Key	.eventId
Event Type	.type
Severity	.severity
Event State	.state
Description	.description
Start Time	.eventCreated
Entity ID	.entityId
Customer ID	.customerId
SaaS Name	.saas
Confidence Indicator	.confidenceIndicator
Message ID	.entityDetails.entityPayload.internetMessageId
Email subject	.entityDetails.entityPayload.subject
Received Time	.entityDetails.entityPayload.received
Recipient	.entityDetails.entityPayload.recipients
Sender	.entityDetails.entityPayload.fromEmail
toRecipients	.entityDetails.entityPayload.to
CcRecipients	.entityDetails.entityPayload.cc
BccRecipients	.entityDetails.entityPayload.bcc
Reply To Email	.entityDetails.entityPayload.replyToEmail
Is Quarantined	.entityDetails.entityPayload.isQuarantined
File Hash MD5	.entityDetails.entityPayload.attachments[*].MD5
Filename	.entityDetails.entityPayload.attachments[*].name
Filesize	.entityDetails.entityPayload.attachments[*].size
Email Links	.entityDetails.entityPayload.emailLinks
Avanan Ap Scan Verdict	.entityDetails.entitySecurityResult.combinedVerdict.ap
DLP Verdict	.entityDetails.entitySecurityResult.combinedVerdict.dlp
Clicktime Protection Verdict	.entityDetails.entitySecurityResult.combinedVerdict.clicktimeProtection
Shadow It Emails Scan Verdict	.entityDetails.entitySecurityResult.combinedVerdict.shadowIt
Checkpoint AV Scan Verdict	.entityDetails.entitySecurityResult.combinedVerdict.av
SPF Result	.entityDetails.entityPayload.SpfResult
Spam Verdict	.entityDetails.entityPayload.saasSpamVerdict
Mode	.entityDetails.entityPayload.mode

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 Checkpoint Avanan portal. Refer to the HTTP Status Code Registry for details.	Status Code: 422.
Message	The raw data or captured key error message from the integration API server about the API request failure.	Message: value is not a valid enumeration member; permitted: 'phishing', 'malware', 'suspicious malware', 'dlp', 'anomaly', 'shadow_it', 'malicious_url_click', 'malicious_url', 'alert'.

Error Sample Data

Fetch Event failed.

Status Code: 422.

Message: value is not a valid enumeration member; permitted: 'phishing', 'malware', 'suspicious malware', 'dlp', 'anomaly', 'shadow_it', 'malicious_url_click', 'malicious_url', 'alert'

Get Event Details

Retrieves the details of the specified security event(s) by Event ID(s).

READER NOTE

The parameter Event IDs is required to run this command.

You should already have your desired Event IDs on hand to run this command. If you don’t, you can use the Fetch Event command with defined filters to retrieve the desired Event IDs. The Event IDs can be found in the raw data at the path $.responseData[*].eventId.

Input

Input Parameter	Required/Optional	Description	Example
Event IDs	Required	The Avanan internal request ID(s) of the security event(s) to retrieve.	[ "***" ]

Output

Raw Data

The primary response data from the API request.

SAMPLE DATA

JSON

[
    {
        "responseEnvelope": {
            "responseCode": 0,
            "responseTest": "Success",
            "additionalText": "",
            "recordsNumber": 1,
            "totalRecordsNumber": 1,
            "scrollId": "34234345454353343"
        },
        "responseData": {
            "eventId": "***",
            "customerId": "us:***",
            "saas": "office365_emails",
            "entityId": "***",
            "state": "dismissed",
            "type": "dlp",
            "confidenceIndicator": "malicious",
            "eventCreated": "2020-07-24T20:58:27.073355+00:00",
            "severity": "Low",
            "data": "",
            "description": "DLP Engine has detected a leak in 'please see my credit data' from user@customer.com",
            "additionalData": "some links here and additional parameters",
            "availableEventActions": [
                {
                    "actionName": "dismiss",
                    "actionParameter": {
                        "eventId": "***"
                    }
                },
                {
                    "actionName": "severityChange",
                    "actionParameter": {
                        "newSeverity": "Low"
                    }
                },
                {
                    "actionName": "severityChange",
                    "actionParameter": {
                        "newSeverity": "Medium"
                    }
                },
                {
                    "actionName": "severityChange",
                    "actionParameter": {
                        "newSeverity": "High"
                    }
                },
                {
                    "actionName": "severityChange",
                    "actionParameter": {
                        "newSeverity": "Highest"
                    }
                }
            ]
        }
    }
]

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

{
    "EventIDs": "\"[ \\\"***\\\" ]\"",
    "Severities": "\"[ \\\"Low\\\" ]\""
}

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

Events 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 Event Details failed.
Status Code	The response code issued by the third-party API server or the D3 SOAR system that can be used to locate the corresponding error category. For example, if the returned status code is 401, the selected connection is unauthorized to run the command. The user or system support would need to check the permission setting in the Checkpoint Avanan 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: failed to get details of the event.

Error Sample Data

Get Event Details failed.

Status Code: 404.

Message: failed to get details of the event.

List Exceptions

Retrieves all existing exceptions.

READER NOTE

Scope is an optional parameter to run this command.

Run the List Scopes command to obtain Scopes. Scopes can be found from the returned raw data at the path $.responseData[*].

Input

Input Parameter	Required/Optional	Description	Example
Exception Type	Required	The Exception Type to retrieve. The available options are White List and Black List.	Black List
Scope	Optional	The scope in which to retrieve exceptions. Scope can be obtained using the List Scopes command.	mt-prod-3:d3securityapi

Output

Raw Data

The primary response data from the API request.

SAMPLE DATA

JSON

{
    "responseEnvelope": {
        "requestId": "***-***-***-***-***",
        "responseCode": 200,
        "responseText": "",
        "additionalText": "",
        "recordsNumber": 1,
        "scrollId": ""
    },
    "responseData": [
        {
            "entityId": "***",
            "attachmentMd5": null,
            "senderEmail": "test@example.com",
            "senderName": null,
            "recipient": null,
            "senderClientIp": null,
            "senderDomain": null,
            "senderIp": null,
            "linkDomains": null,
            "subject": "AUT-phish-prod3-17-_200923_23_11_3",
            "comment": "",
            "actionNeeded": "",
            "matchOnlyFuture": "",
            "quarantineAll": null,
            "ignoringSpfCheck": false,
            "subjectMatching": "contains",
            "linkDomainMatching": null,
            "senderNameMatching": "",
            "senderDomainMatching": "",
            "senderEmailMatching": "",
            "recipientMatching": "",
            "addedBy": "5",
            "editedBy": null,
            "updateTime": "2020-09-25T21:54:17.706787"
        }
    ]
}

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

{
    "ExceptionEntityIDs": "\"[ \\\"***\\\" ]\"",
    "SenderEmails": "\"[ \\\"test@example.com\\\" ]\"",
    "Recipients": "\"[ NULL ]\"",
    "Subjects": "\"[ \\\"AUT-phish-prod3-17-_200923_23_11_3\\\" ]\"",
    "AttachmentMD5": "\"[ \\\"\\\" ]\"",
    "SenderIPs": "\"[ \\\"\\\" ]\"",
    "ActionsNeeded": "\"[ \\\"\\\" ]\""
}

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

Exception Entities Count

1

Error Handling

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

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

Parts in Error	Description	Example
Failure Indicator	Indicates the command failure that happened at a specific input and/or API call.	List Exceptions 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 Checkpoint Avanan portal. Refer to the HTTP Status Code Registry for details.	Status Code: 403.
Message	The raw data or captured key error message from the integration API server about the API request failure.	Message: Request scope[xxxx] is not authorized, authorized scopes: ['xxxx'].

Error Sample Data

List Exceptions failed.

Status Code: 403.

Message: Request scope[xxxx] is not authorized, authorized scopes: ['xxxx'].

List Scopes

Retrieves the list of supported scopes.

Input

N/A

Output

Raw Data

The primary response data from the API request.

SAMPLE DATA

JSON

{
    "responseEnvelope": {
        "requestId": "***-***-***-***-***",
        "responseCode": 200,
        "responseText": "string",
        "additionalText": "string",
        "recordsNumber": 2,
        "scrollId": "string"
    },
    "responseData": [
        "us:customername",
        "us:customername2"
    ]
}

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

{
    "Scopes": "\"[ \\\"us:customername\\\", \\\"us:customername2\\\" ]\""
}

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

AvailableScopeCount

2

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

Error Sample Data

List Scopes failed.

Status Code: 403.

Message: Forbidden.

Take Action On Events

Performs a single action on a specific security event or multiple events.

READER NOTE

The parameter Event IDs is required to run this command.
- You should already have your desired Event IDs on hand to run this command. If you don’t, you can use the Fetch Event command with defined filters to retrieve the desired Event IDs. The Event IDs can be found in the raw data at the path $.responseData[*].eventId.
Scope is an optional parameter to run this command.
- Run the List Scopes command to obtain Scopes. Scopes can be found from the returned raw data at the path $.responseData[*].

Input

Input Parameter	Required/Optional	Description	Example
Scope	Optional	The scope to take action. Scopes can be obtained using the List Scopes command.	mt-prod-3:d3securityapi
Event IDs	Required	The ID(s) of the security event(s) that the single action applies to. Event IDs can be obtained using the Fetch Event command.	[ "***" ]
Event Action Name	Required	The name of the action to take. The available actions are Quarantine and Restore.	Restore
Event Action Parameter	Optional	Optional string with all action parameters.	test

Output

Raw Data

The primary response data from the API request.

SAMPLE DATA

JSON

{
    "responseEnvelope": {
        "requestId": "***-***-***-***-***",
        "responseCode": 0,
        "responseText": "success",
        "additionalText": "",
        "recordsNumber": 1,
        "totalRecordsNumber": 1,
        "scrollId": "***"
    },
    "responseData": [
        {
            "eventId": "***",
            "entityId": "***",
            "taskId": "***"
        }
    ]
}

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

{
    "AccessRuleNames": "\"[\\\"phishing-sample-com\\\"]\""
}

Return Data

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

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

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

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

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

SAMPLE DATA

CODE

Successful

Result

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

SAMPLE DATA

Counts of Events on which the action was taken

1

Error Handling

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

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

Parts in Error	Description	Example
Failure Indicator	Indicates the command failure that happened at a specific input and/or API call.	Take Action On Events 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 Checkpoint Avanan portal. Refer to the HTTP Status Code Registry for details.	Status Code: 403.
Message	The raw data or captured key error message from the integration API server about the API request failure.	Message: Request scope[xxxx] is not authorized, authorized scopes: ['xxxx'].

Error Sample Data

Take Action On Events failed.

Status Code: 403.

Message: Request scope[xxxx] is not authorized, authorized scopes: ['xxxx'].

Update Exception

Modifies an exception.

READER NOTE

Exception Entity ID is a required parameter to run this command.

Run the List Exceptions command to obtain Exception Entity ID. Exception Entity IDs can be found in the returned raw data at the path $.responseData[*].entityId.

Input

Input Parameter	Required/Optional	Description	Example
Exception Type	Required	The type of the Exception to be updated. The available options are White List and Black List.	Black List
Exception Entity ID	Required	The ID(s) of the Exception(s) to be updated. Exception IDs can be obtained using the List Exceptions command.
Attachment MD5 Hash	Optional	The MD5 hash value of the attachment.
Sender Email	Optional	The email address of the sender.	test@example.com
Sender Name	Optional	The name of the sender.	user3abc
Recipient	Optional	The email address of the recipient.	test@example.com
Sender Client IP	Optional	The client IP address of the sender.	10.0.0.0
Sender Domain	Optional	The domain name of the sender.	example.com
Sender IP	Optional	The IP address of the sender.	200.200.200.200
Link Domains	Optional	The linked domain names.	phishing.com
Subject	Optional	The subject for the exception.	testSubject
Comment	Optional	The comment for the exception.	testUpdateBlacklist
Action Needed	Optional	The action to be taken. The available options are Spam and Phishing. Please note, this parameter is valid only when the Exception Type is Black List.	Phishing
Subject Matching	Optional	The Subject matching type.The available options are Contains or Match.	Contains
Link Domain Matching	Optional	The Link Domain matching type. The available options are Contains or Match.	Contains
Sender Name Matching	Optional	The Sender Name matching type. The available options are Contains or Match.	Contains
Sender Domain Matching	Optional	The Sender Domain matching type. The available options are Contains, Match or Ends With.	Ends With
Recipient Matching	Optional	The Recipient Email address matching type. The available options are Contains or Match.	Contains

Output

Raw Data

The primary response data from the API request.

SAMPLE DATA

JSON

{
    "responseEnvelope": {
        "requestId": "***-***-***-***-***",
        "responseCode": 200,
        "responseText": "",
        "additionalText": "",
        "recordsNumber": 1,
        "scrollId": ""
    },
    "responseData": []
}

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

requestId	1234
responseCode	200
responseText
additionalText
recordsNumber	0
scrollId

Error Handling

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

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

Parts in Error	Description	Example
Failure Indicator	Indicates the command failure that happened at a specific input and/or API call.	Update Exception 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 Checkpoint Avanan portal. Refer to the HTTP Status Code Registry for details.	Status Code: 403.
Message	The raw data or captured key error message from the integration API server about the API request failure.	Message: Forbidden.

Error Sample Data

Update Exception failed.

Status Code: 403.

Message: Forbidden.

Test Connection

Allows you to perform a health check on an integration connection. You can schedule a periodic health check by selecting Connection Health Check when editing an integration connection.

Input

N/A

Output

Return Data

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

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

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

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

SAMPLE DATA

CODE

Successful

Error Handling

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

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

Parts in Error	Description	Example
Failure Indicator	Indicates the command failure that happened at a specific input and/or API call.	Test Connection failed. Failed to check the connector.
Status Code	The response code issued by the third-party API server or the D3 SOAR system that can be used to locate the corresponding error category. For example, if the returned status code is 401, the selected connection is unauthorized to run the command. The user or system support would need to check the permission setting in the Checkpoint Avanan portal. Refer to the HTTP Status Code Registry for details.	Status Code: 403.
Message	The raw data or captured key error message from the integration API server about the API request failure.	Message: Forbidden.

Error Sample Data

Test Connection failed. Failed to check the connector.

Status Code: 403.

Message: Forbidden.