Add Root Key for Local Shared Data

This command can only be executed within an event/incident playbook. Adds a specified root key to the input Local Shared Data.

Reader Note

Please note that this command is only applicable within an event Playbook.

Implementation	System
Command Category	System Utility
Tags	CONTEXT DATA LOCAL SHARED DATA

Inputs

Parameter Name	Required/Optional	Description	Sample Data
Input	Optional	The JSON object that needs to be updated in the local shared data.	`{` `"User": "Tom",` `"IPAddress":"13.64.156.22",` `"RiskLevel": "Medium"` `}`
JSON Path	Optional	The JSON Path with a Root key name	`$.Root`

Output

Return Data

The returned result of this command. If some required parameters are not defined, this returned data could be empty. The returned result can be passed down directly to a subsequent command in playbooks.

SAMPLE DATA

JSON

Successful

Context Data

The response data from the utility command.

SAMPLE DATA

JSON

{
    "Root": {
        "User": "Tom",
        "IPAddress": "13.64.156.22",
        "RiskLevel": "Medium"
    }
}

Remote Command API

The D3 command API allows you to send requests to D3 SOAR to execute this utility command via REST API.

Request

POST

CODE

https:/{base_url}/{api_namespace}/api/Command/SetContextKeyValuePairs

Headers

Please refer to the page Webhook Configuration Guide - Authentication Method: API Keys for more details.

Request Body

JSON

{
  "Username": <Username here>,
  "Site": <Site here>,
  "CommandParams": {
    "Input": <Event IDs here>,
    "JSON Path": <JSON Path here>
  }
}

Body Parameters

Parameter Name	Type	Required/Optional	Description
Username	`String`	Required	The username of your D3 SOAR account.
Site	`String`	Required	The D3 SOAR site to run the remote command.
Input	`JSON Object`	Optional	The JSON object that needs to be updated in the local shared data.
JSON Path	`Text`	Optional	The JSON Path with a Root key name

Sample Request

SAMPLE DATA

JSON

{
  "Username": "Admin",
  "Site": "Security Operations",
  "CommandParams": {
    "Input": {
      "User": "Tom",
      "IPAddress": "13.64.156.22",
      "RiskLevel": "Medium"
    },
    "JSON Path": "$.Root"
  }
}

Response

Response Fields

Field Name	Type	Description
error	`String`	The error message if the API request has failed.
returnData	`String`	The return data from the API request.
contextData	`JSON`	The context data from the API request.

Sample Response

JSON

{
    "error": "",
    "returnData": "Successful",
    "contextData": "{
      "Root": {
          "User": "Tom",
          "IPAddress": "13.64.156.22",
          "RiskLevel": "Medium"
      }
  }"
}