Atlassian OpsGenie

LAST UPDATED: 06/04/2024

Overview

Opsgenie is a cloud-based incident management platform that ensures alerts from your monitoring systems and custom applications are well managed, so that critical incidents are never missed, and actions are taken by the right people in the shortest possible time. This integration enables organizations to manage on-call schedules and other items.

D3 SOAR is providing REST operations to function with Atlassian OpsGenie.

Atlassian OpsGenie is available for use in:

D3 SOAR	V12.7.241+
Category	IT and Infrastructure
Deployment Options	Option II, Option IV

Known Limitations

Please refer to OpsGenie > Rate Limiting for details on rate limiting.

Connection

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

Parameter	Description	Example
Server URL	The URL of the OpsGenie instance.	https://api.opsgenie.com
API Key	The dedicated API key.	668b**-53c0--b7b4-c009**1983
API Version	The version of the APIs.	v2

Permission Requirements

Each endpoint in the Atlassian OpsGenie API requires a certain permission scope. For all commands in this integration both the Read and Configuration access rights are needed.

READER NOTE

The API key is controlled by the access rights configured for the API key. There are four access rights to choose from:

Read
Create and update
Delete
Configuration access

For instructions on how to obtain the API key and configure the access rights, please refer to the Configuring Atlassian OpsGenie to Work with D3 SOAR section below.

Configuring Atlassian OpsGenie to Work with D3 SOAR

Log in to OpsGenie with your username and password.
Click on the Settings tab at the top of the interface.
Click on the API key management option from the left navigation menu.
Click on the Add new API key button at the top right corner.
Enter the Name for the new API key in the form popup. Copy the Key and store it in a proper place for future reference. Select the appropriate Access rights (please refer to Permission Requirements for the minimum rights needed to execute commands). Click on the Add API key button to complete the process.
You will find the API key you just created is listed on the API key management list.

Configuring D3 SOAR to Work with Atlassian OpsGenie

Log in to D3 SOAR.
Find the Atlassian OpsGenie integration.
1. Navigate to Configuration on the top header menu.
2. Click on the Integration icon on the left sidebar.
3. Type Atlassian OpsGenie 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 Atlassian OpsGenie.
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.
  1. 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://api.opsgenie.com.
    2. Copy the API Key from the Atlassian OpsGenie platform. Please refer to step 5 of Configuring Atlassian OpsGenie to Work with D3 SOAR.
    3. Input the API Version. The default value is v2.
9. 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.
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 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.
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

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

READER NOTE

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

Note for Time-related parameters

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

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

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

Fetch Event

Retrieves alerts matching the given criteria.

Input

Input Parameter	Required/Optional	Description	Example
Start Time	Optional	The start time of the time range to query alerts by alert update time, in UTC Time.	2020-06-03 00:00
End Time	Optional	The end time of the time range to query alerts by alert update time, in UTC Time.	2020-12-31 00:00
Number of Event(s) Fetched	Optional	The maximum number of alerts to return. The default value is 20. The maximum input is 100.	100
Search Condition	Optional	The query conditions used to narrow down search results. Please refer to Search queries for alerts \| Opsgenie \| Atlassian Support for more information.	"message: timmy* AND acknowledged:false AND priority:(P1 OR P2)"

Output

Return Data

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

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

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

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

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

SAMPLE DATA

CODE

Successful

Raw Data

The primary response data from the API request.

SAMPLE DATA

JSON

{
    "data": [
        {
            "seen": false,
            "id": "*****",
            "tinyId": "2",
            "alias": "*****",
            "message": "Timmy incident",
            "status": "open",
            "acknowledged": false,
            "isSeen": false,
            "tags": [
                "Timmy incident"
            ],
            "snoozed": false,
            "count": 1,
            "lastOccurredAt": "2020-06-03T00:53:05.771Z",
            "createdAt": "2020-06-03T00:53:05.771Z",
            "updatedAt": "2020-06-03T01:03:05.977Z",
            "source": "",
            "owner": "",
            "priority": "P1",
            "teams": [
                {
                    "id": "*****"
                }
            ],
            "responders": [
                {
                    "type": "team",
                    "id": "*****"
                }
            ],
            "ownerTeamId": "*****"
        }
    ],
    "paging": {
        "first": "https://api.opsgenie.com/v2/*****",
        "last": "https://api.opsgenie.com/v2/*****"
    },
    "took": 0.074,
    "requestId": "*****"
}

Context Data

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

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

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

SAMPLE DATA

CODE

[
    {
        "seen": false,
        "id": "*****",
        "tinyId": "2",
        "alias": "*****",
        "message": "Timmy incident",
        "status": "open",
        "acknowledged": false,
        "isSeen": false,
        "tags": [
            "Timmy incident"
        ],
        "snoozed": false,
        "count": 1,
        "lastOccurredAt": "2020-06-03T00:53:05.771Z",
        "createdAt": "2020-06-03T00:53:05.771Z",
        "updatedAt": "2020-06-03T01:03:05.977Z",
        "source": "",
        "owner": "",
        "priority": "P1",
        "teams": [
            {
                "id": "*****"
            }
        ],
        "responders": [
            {
                "type": "team",
                "id": "*****"
            }
        ],
        "ownerTeamId": "*****"
    }
]

Key Fields

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

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

SAMPLE DATA

CODE

{
  "AlertIDs": ["*****"],
  "TinyIDs": ["***"]
}

Result

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

SAMPLE DATA

seen	id	tinyId	alias	message	status	acknowledged	isSeen	tags	snoozed	count	lastOccurredAt	createdAt	updatedAt	source	owner	priority	teams	responders	ownerTeamId
False	*****	2	*****	Timmy incident	open	False	False	['Timmy incident']	False	1	2020-06-03T00:53:05.771Z	2020-06-03T00:53:05.771Z	2020-06-03T01:03:05.977Z			P1	[{'id': '*****'}]	[{'type': 'team', 'id': '*****'}]	*****

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 Atlassian OpsGenie 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 alerts. 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
Original event ID	.tinyId
Event name	.alias
Status	.status
Message	.message
Aggregated / Correlated Event count	.count
Priority	.priority
Start Time	.createdAt
Acknowledged	.acknowledged

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 Atlassian OpsGenie 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: No handler found.

Error Sample Data

Fetch Event failed.

Status Code: 404.

Message: No handler found.

Get On-call User

Retrieves current on-call participants for a specific schedule.

READER NOTE

Schedule Name is a required parameter to run this command.

Run the Get Schedules command to obtain the Schedule Name. Schedule Names can be found in the raw data at the path $.data[*].name.

Input

Input Parameter	Required/Optional	Description	Example
Schedule Name	Required	The name of the schedule. Schedule Name can be obtained using the Get Schedules command.	sysint1_schedule
Datetime	Optional	The starting time of the timeline. The default date is the time when the request is received.	2022-01-15 00:00

Output

Return Data

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

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

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

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

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

SAMPLE DATA

CODE

Successful

Raw Data

The primary response data from the API request.

SAMPLE DATA

JSON

{
    "data": {
        "_parent": {
            "id": "*****",
            "name": "sysint1_schedule",
            "enabled": true
        },
        "onCallParticipants": [
            {
                "id": "*****",
                "name": "sysint@d3security.com",
                "type": "user"
            }
        ]
    },
    "took": 0.006,
    "requestId": "*****"
}

Context Data

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

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

SAMPLE DATA

CODE

{
    "_parent": {
        "id": "*****",
        "name": "sysint1_schedule",
        "enabled": true
    },
    "onCallParticipants": [
        {
            "id": "*****",
            "name": "sysint@d3security.com",
            "type": "user"
        }
    ]
}

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

{
  "ScheduleID": "*****",
  "ScheduleName": "sysint1_schedule"
}

Result

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

SAMPLE DATA

_parent	{'id': '*****', 'name': 'sysint1_schedule', 'enabled': True}
onCallParticipants	{'id': '*****', 'name': 'sysint@d3security.com', 'type': 'user'}

Error Handling

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

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

Parts in Error	Description	Example
Failure Indicator	Indicates the command failure that happened at a specific input and/or API call.	Get On-call User 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 Atlassian OpsGenie portal. Refer to the HTTP Status Code Registry for details.	Status Code: 429.
Message	The raw data or captured key error message from the integration API server about the API request failure.	Message: You are making too many requests! To avoid errors, we recommend you limit requests.

Error Sample Data

Get On-call User failed.

Status Code: 429.

Message: You are making too many requests! To avoid errors, we recommend you limit requests.

Get Schedules

Retrieves all schedules.

Input

N/A

Output

Return Data

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

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

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

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

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

SAMPLE DATA

CODE

Successful

Raw Data

The primary response data from the API request.

SAMPLE DATA

JSON

{
    "data": [
        {
            "id": "*****",
            "name": "Timmy Schedule",
            "description": "Timmy Schedule",
            "timezone": "America/Los_Angeles",
            "enabled": true,
            "ownerTeam": {
                "id": "*****",
                "name": "sysint1"
            },
            "rotations": []
        },
        {
            "id": "*****",
            "name": "sysint1_schedule",
            "description": "",
            "timezone": "America/Los_Angeles",
            "enabled": true,
            "ownerTeam": {
                "id": "*****",
                "name": "sysint1"
            },
            "rotations": [
                {
                    "id": "*****",
                    "name": "Rot1",
                    "startDate": "2020-06-01T07:00:00Z",
                    "type": "weekly",
                    "length": 1,
                    "participants": [
                        {
                            "type": "user",
                            "id": "*****",
                            "username": "sysint@d3security.com"
                        }
                    ]
                }
            ]
        },
        {
            "id": "*****",
            "name": "sysint_schedule",
            "description": "",
            "timezone": "America/Los_Angeles",
            "enabled": true,
            "ownerTeam": {
                "id": "*****",
                "name": "sysint"
            },
            "rotations": [
                {
                    "id": "*****",
                    "name": "Rot1",
                    "startDate": "2020-06-01T07:00:00Z",
                    "type": "weekly",
                    "length": 1,
                    "participants": [
                        {
                            "type": "user",
                            "id": "*****",
                            "username": "*****@d3security.com"
                        }
                    ]
                },
                {
                    "id": "*****",
                    "name": "Rota2",
                    "startDate": "2020-06-02T15:00:00Z",
                    "type": "daily",
                    "length": 1,
                    "participants": [
                        {
                            "type": "user",
                            "id": "*****",
                            "username": "*****@d3security.com"
                        }
                    ]
                }
            ]
        }
    ],
    "expandable": [
        "rotation"
    ],
    "took": 0.011,
    "requestId": "*****"
}

Context Data

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

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

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

SAMPLE DATA

CODE

[
    {
        "id": "*****",
        "name": "Timmy Schedule",
        "description": "Timmy Schedule",
        "timezone": "America/Los_Angeles",
        "enabled": true,
        "ownerTeam": {
            "id": "*****",
            "name": "sysint1"
        },
        "rotations": []
    },
    {
        "id": "*****",
        "name": "sysint1_schedule",
        "description": "",
        "timezone": "America/Los_Angeles",
        "enabled": true,
        "ownerTeam": {
            "id": "*****",
            "name": "sysint1"
        },
        "rotations": [
            {
                "id": "*****",
                "name": "Rot1",
                "startDate": "2020-06-01T07:00:00Z",
                "type": "weekly",
                "length": 1,
                "participants": [
                    {
                        "type": "user",
                        "id": "*****",
                        "username": "sysint@d3security.com"
                    }
                ]
            }
        ]
    },
    {
        "id": "*****",
        "name": "sysint_schedule",
        "description": "",
        "timezone": "America/Los_Angeles",
        "enabled": true,
        "ownerTeam": {
            "id": "*****",
            "name": "sysint"
        },
        "rotations": [
            {
                "id": "*****",
                "name": "Rot1",
                "startDate": "2020-06-01T07:00:00Z",
                "type": "weekly",
                "length": 1,
                "participants": [
                    {
                        "type": "user",
                        "id": "*****",
                        "username": "*****@d3security.com"
                    }
                ]
            },
            {
                "id": "*****",
                "name": "Rota2",
                "startDate": "2020-06-02T15:00:00Z",
                "type": "daily",
                "length": 1,
                "participants": [
                    {
                        "type": "user",
                        "id": "*****",
                        "username": "*****@d3security.com"
                    }
                ]
            }
        ]
    }
]

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

{
  "ScheduleIDs": ["*****"],
  "ScheduleNames": ["sysint_schedule"]
}

Result

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

SAMPLE DATA

id	name	description	timezone	enabled	ownerTeam	rotations
*****	Timmy Schedule	Timmy Schedule	America/Los_Angeles	True	{'id': '*****', 'name': 'sysint1'}	[]
*****	sysint1_schedule		America/Los_Angeles	True	{'id': '*****', 'name': 'sysint1'}	[{'id': '***', 'name': 'Rot1', 'startDate': '2020-06-01T07:00:00Z', 'type': 'weekly', 'length': 1, 'participants': [{'type': 'user', 'id': '***', 'username': 'sysint@d3security.com'}]}]
*****	sysint_schedule		America/Los_Angeles	True	{'id': '*****', 'name': 'sysint'}	[{'id': '***', 'name': 'Rot1', 'startDate': '2020-06-01T07:00:00Z', 'type': 'weekly', 'length': 1, 'participants': [{'type': 'user', 'id': '*', 'username': '*@d3security.com'}]}, {'id': '*', 'name': 'Rota2', 'startDate': '2020-06-02T15:00:00Z', 'type': 'daily', 'length': 1, 'participants': [{'type': 'user', 'id': '*', 'username': '***@d3security.com'}]}]

Error Handling

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

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

Parts in Error	Description	Example
Failure Indicator	Indicates the command failure that happened at a specific input and/or API call.	Get Schedules 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 Atlassian OpsGenie 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: Could not authenticate.

Error Sample Data

Get Schedules failed.

Status Code: 401.

Message: Could not authenticate.

Get Schedule Timeline

Retrieves the schedule’s timeline, which includes the time and on-call recipient details.

READER NOTE

Schedule Name is a required parameter to run this command.

Run the Get Schedules command to obtain the Schedule Name. Schedule Names can be found in the raw data at the path $.data[*].name.

Input

Input Parameter	Required/Optional	Description	Example
Schedule Name	Required	The name of the schedule. Schedule Name can be obtained using the Get Schedules command.	sysint_schedule

Output

Return Data

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

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

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

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

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

SAMPLE DATA

CODE

Successful

Raw Data

The primary response data from the API request.

SAMPLE DATA

JSON

{
    "data": {
        "_parent": {
            "id": "*****",
            "name": "sysint_schedule",
            "enabled": true
        },
        "startDate": "2022-01-17T08:00:00Z",
        "endDate": "2022-01-24T08:00:00Z",
        "finalTimeline": {
            "rotations": [
                {
                    "id": "*****",
                    "name": "Rot1",
                    "order": 1,
                    "periods": [
                        {
                            "startDate": "2022-01-17T08:00:00Z",
                            "endDate": "2022-01-20T17:50:16.011Z",
                            "type": "historical",
                            "recipient": {
                                "id": "*****",
                                "type": "user",
                                "name": "*****@d3security.com"
                            },
                            "flattenedRecipients": [
                                {
                                    "id": "*****",
                                    "type": "user",
                                    "name": "*****@d3security.com"
                                }
                            ]
                        },
                        {
                            "startDate": "2022-01-20T17:50:16.011Z",
                            "endDate": "2022-01-24T08:00:00Z",
                            "type": "default",
                            "recipient": {
                                "id": "*****",
                                "type": "user",
                                "name": "*****@d3security.com"
                            }
                        }
                    ]
                },
                {
                    "id": "*****",
                    "name": "Rota2",
                    "order": 2,
                    "periods": [
                        {
                            "startDate": "2022-01-17T08:00:00Z",
                            "endDate": "2022-01-20T17:50:16.011Z",
                            "type": "historical",
                            "recipient": {
                                "id": "*****",
                                "type": "user",
                                "name": "*****@d3security.com"
                            },
                            "flattenedRecipients": [
                                {
                                    "id": "*****",
                                    "type": "user",
                                    "name": "*****@d3security.com"
                                }
                            ]
                        },
                        {
                            "startDate": "2022-01-20T17:50:16.011Z",
                            "endDate": "2022-01-24T08:00:00Z",
                            "type": "default",
                            "recipient": {
                                "id": "*****",
                                "type": "user",
                                "name": "*****@d3security.com"
                            }
                        }
                    ]
                }
            ]
        }
    },
    "expandable": [
        "base",
        "forwarding",
        "override"
    ],
    "took": 0.099,
    "requestId": "*****"
}

Context Data

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

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

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

SAMPLE DATA

CODE

{
    "_parent": {
        "id": "*****",
        "name": "sysint_schedule",
        "enabled": true
    },
    "startDate": "2022-01-17T08:00:00Z",
    "endDate": "2022-01-24T08:00:00Z",
    "finalTimeline": {
        "rotations": [
            {
                "id": "*****",
                "name": "Rot1",
                "order": 1,
                "periods": [
                    {
                        "startDate": "2022-01-17T08:00:00Z",
                        "endDate": "2022-01-20T17:50:16.011Z",
                        "type": "historical",
                        "recipient": {
                            "id": "*****",
                            "type": "user",
                            "name": "*****@d3security.com"
                        },
                        "flattenedRecipients": [
                            {
                                "id": "*****",
                                "type": "user",
                                "name": "*****@d3security.com"
                            }
                        ]
                    },
                    {
                        "startDate": "2022-01-20T17:50:16.011Z",
                        "endDate": "2022-01-24T08:00:00Z",
                        "type": "default",
                        "recipient": {
                            "id": "*****",
                            "type": "user",
                            "name": "*****@d3security.com"
                        }
                    }
                ]
            },
            {
                "id": "*****",
                "name": "Rota2",
                "order": 2,
                "periods": [
                    {
                        "startDate": "2022-01-17T08:00:00Z",
                        "endDate": "2022-01-20T17:50:16.011Z",
                        "type": "historical",
                        "recipient": {
                            "id": "*****",
                            "type": "user",
                            "name": "*****@d3security.com"
                        },
                        "flattenedRecipients": [
                            {
                                "id": "*****",
                                "type": "user",
                                "name": "*****@d3security.com"
                            }
                        ]
                    },
                    {
                        "startDate": "2022-01-20T17:50:16.011Z",
                        "endDate": "2022-01-24T08:00:00Z",
                        "type": "default",
                        "recipient": {
                            "id": "*****",
                            "type": "user",
                            "name": "*****@d3security.com"
                        }
                    }
                ]
            }
        ]
    }
}

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

{
  "ScheduleID": "*****",
  "ScheduleName": "sysint_schedule"
}

Result

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

SAMPLE DATA

_parent	{'id': '*****', 'name': 'sysint_schedule', 'enabled': True}
startDate	2022-01-17T08:00:00Z
endDate	2022-01-24T08:00:00Z
finalTimeline	{'rotations': [{'id': '***', 'name': 'Rot1', 'order': 1.0, 'periods': [{'startDate': '2022-01-17T08:00:00Z', 'endDate': '2022-01-20T17:50:16.011Z', 'type': 'historical', 'recipient': {'id': '*', 'type': 'user', 'name': '*@d3security.com'}, 'flattenedRecipients': [{'id': '*', 'type': 'user', 'name': '*@d3security.com'}]}, {'startDate': '2022-01-20T17:50:16.011Z', 'endDate': '2022-01-24T08:00:00Z', 'type': 'default', 'recipient': {'id': '*', 'type': 'user', 'name': '*@d3security.com'}}]}, {'id': '*', 'name': 'Rota2', 'order': 2.0, 'periods': [{'startDate': '2022-01-17T08:00:00Z', 'endDate': '2022-01-20T17:50:16.011Z', 'type': 'historical', 'recipient': {'id': '*', 'type': 'user', 'name': '*@d3security.com'}, 'flattenedRecipients': [{'id': '*', 'type': 'user', 'name': '*@d3security.com'}]}, {'startDate': '2022-01-20T17:50:16.011Z', 'endDate': '2022-01-24T08:00:00Z', 'type': 'default', 'recipient': {'id': '*', 'type': 'user', 'name': '***@d3security.com'}}]}]}

Error Handling

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

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

Parts in Error	Description	Example
Failure Indicator	Indicates the command failure that happened at a specific input and/or API call.	Get Schedule Timeline 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 Atlassian OpsGenie 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: No schedule exists with name [<Text>].

Error Sample Data

Get Schedule Timeline failed.

Status Code: 404.

Message: No schedule exists with name [<Text>].

Get Single User

Retrieves a single user.

READER NOTE

Username or ID is a required parameter to run this command.

Run the Get On-call User command to obtain the Username or ID. Usernames can be found in the raw data at the path $.onCallParticipants[*].name; IDs can be found in the raw data at the path $.onCallParticipants[*].id.

Input

Input Parameter	Required/Optional	Description	Example
Username or ID	Required	The username or ID of the user. Username or ID can be obtained using the Get On-call User command.	sysint@d3security.com

Output

Return Data

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

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

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

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

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

SAMPLE DATA

CODE

Successful

Raw Data

The primary response data from the API request.

SAMPLE DATA

JSON

{
    "data": {
        "blocked": false,
        "verified": true,
        "id": "*****",
        "username": "sysint@d3security.com",
        "fullName": "D3 System Engineer Team",
        "role": {
            "id": "User",
            "name": "User"
        },
        "timeZone": "America/Los_Angeles",
        "locale": "en_US",
        "userAddress": {
            "country": "",
            "state": "",
            "city": "",
            "line": "",
            "zipCode": ""
        },
        "createdAt": "2020-06-03T00:42:42.323Z",
        "userContacts": [
            {
                "to": "sysint@d3security.com",
                "id": "*****",
                "contactMethod": "email",
                "enabled": true
            }
        ]
    },
    "expandable": [
        "contact"
    ],
    "took": 0.03,
    "requestId": "*****"
}

Context Data

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

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

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

SAMPLE DATA

CODE

{
    "blocked": false,
    "verified": true,
    "id": "*****",
    "username": "sysint@d3security.com",
    "fullName": "D3 System Engineer Team",
    "role": {
        "id": "User",
        "name": "User"
    },
    "timeZone": "America/Los_Angeles",
    "locale": "en_US",
    "userAddress": {
        "country": "",
        "state": "",
        "city": "",
        "line": "",
        "zipCode": ""
    },
    "createdAt": "2020-06-03T00:42:42.323Z",
    "userContacts": [
        {
            "to": "sysint@d3security.com",
            "id": "*****",
            "contactMethod": "email",
            "enabled": true
        }
    ]
}

Key Fields

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

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

SAMPLE DATA

CODE

{
  "UserName": "sysint@d3security.com",
  "UserID": "*****",
  "UserFullName": "D3 System Engineer Team" 
}

Result

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

SAMPLE DATA

blocked	False
verified	True
id	*****
username	sysint@d3security.com
fullName	D3 System Engineer Team
role	{'id': 'User', 'name': 'User'}
timeZone	America/Los_Angeles
locale	en_US
userAddress	{'country': '', 'state': '', 'city': '', 'line': '', 'zipCode': ''}
createdAt	2020-06-03T00:42:42.323Z
userContacts	{'to': 'sysint@d3security.com', 'id': '*****', 'contactMethod': 'email', 'enabled': True}

Error Handling

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

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

Parts in Error	Description	Example
Failure Indicator	Indicates the command failure that happened at a specific input and/or API call.	Get Single User 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 Atlassian OpsGenie 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: User not found with identifier [sysint@d3security.com].

Error Sample Data

Get Single User failed.

Status Code: 404.

Message: User not found with identifier [sysint@d3security.com].

Test Connection

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

Input

N/A

Output

Return Data

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

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

A connection issue with the integration

The API returned an error message

No response from the API

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

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

SAMPLE DATA

CODE

Successful

Error Handling

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

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

Parts in Error	Description	Example
Failure Indicator	Indicates the command failure that happened at a specific input and/or API call.	Test Connection failed. Failed to check the connector.
Status Code	The response code issued by the third-party API server or the D3 SOAR system that can be used to locate the corresponding error category. For example, if the returned status code is 401, the selected connection is unauthorized to run the command. The user or system support would need to check the permission setting in the Atlassian OpsGenie 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: Key format is not valid!

Error Sample Data

Test Connection failed. Failed to check the connector.

Status Code: 422.

Message: Key format is not valid!