Update Global List

Update object in the specified global list matching by key and value pair.

Implementation	System
Command Category	System Utility
Tags	GLOBAL LIST

Inputs

Parameter Name	Required/Optional	Description	Sample Data
Global List Name	Optional	The name of the global list.	`MacToSysNameMappingList`
Key	Optional	The key to match in existing global list content.	`SystemName`
Value	Optional	The value to match in existing global list content.	`D3CYBER-PC1`
Object	Optional	The object used to replace the matched objects in the global list content.	CODE `{ "GroupID": 8, "SystemName": "D3CYBER-PC3", "MACAddress": "000C29D3323A" }`

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

Succeed

Context Data

The response data from the utility command.

SAMPLE DATA

JSON

{
    "OldList": [
        {
            "GroupID": 2,
            "SystemName": "D3Lab-AD",
            "MACAddress": "020806A536C7"
        },
        {
            "GroupID": 2,
            "SystemName": "D3LAB02",
            "MACAddress": "090706B536C3"
        },
        {
            "GroupID": 7,
            "SystemName": "D3CYBER-PC1",
            "MACAddress": "000C29D5765F"
        }
    ],
    "NewList": [
        {
            "GroupID": 2,
            "SystemName": "D3Lab-AD",
            "MACAddress": "020806A536C7"
        },
        {
            "GroupID": 2,
            "SystemName": "D3LAB02",
            "MACAddress": "090706B536C3"
        },
        {
            "GroupID": 8,
            "SystemName": "D3CYBER-PC3",
            "MACAddress": "000C29D3323A"
        }
    ]
}

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/UpdateGlobalList

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": {
    "Global List Name": "<Global List Name here>",
    "Key": "<Key here>",
    "Value": "<Value here>",
    "Object": "<Object 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.
Global List Name	`Text`	Optional	The name of the global list.
Key	`Text`	Optional	The key to match in existing global list content.
Value	`Text`	Optional	The value to match in existing global list content.
Object	`JSON Object`	Optional	The object used to replace the matched objects in the global list content.

Sample Request

SAMPLE DATA

JSON

{
  "Username": "Admin",
  "Site": "Security Operations",
  "CommandParams": {
    "Global List Name": "MacToSysNameMappingList",
    "Key": "SystemName",
    "Value": "D3CYBER-PC1",
    "Object": {
      "GroupID": 8,
      "SystemName": "D3CYBER-PC3",
      "MACAddress": "000C29D3323A"
    }
  }
}

Response

Response Fields

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

Sample Response

JSON

{
    "error": "",
    "returnData": "Succeed",
    "contextData": {
        "OldList": [
            {
                "GroupID": 2,
                "SystemName": "D3Lab-AD",
                "MACAddress": "020806A536C7"
            },
            {
                "GroupID": 2,
                "SystemName": "D3LAB02",
                "MACAddress": "090706B536C3"
            },
            {
                "GroupID": 7,
                "SystemName": "D3CYBER-PC1",
                "MACAddress": "000C29D5765F"
            }
        ],
        "NewList": [
            {
                "GroupID": 2,
                "SystemName": "D3Lab-AD",
                "MACAddress": "020806A536C7"
            },
            {
                "GroupID": 2,
                "SystemName": "D3LAB02",
                "MACAddress": "090706B536C3"
            },
            {
                "GroupID": 8,
                "SystemName": "D3CYBER-PC3",
                "MACAddress": "000C29D3323A"
            }
        ]
    }
}