Share Global Lists across Sites

Last updated: aug 08, 2024

Publishes a global list to site(s), rescinds access from site(s), or overwrites existing site assignment(s).

Implementation	System
Command Category	System Utility
Tags	Global List

Inputs

Parameter Name	Required/Optional	Description	Sample Data
Global List Name	Required	The name of the global list.	demoGlobalList
Site List	Required	The sites where the global list access will be published or withdrawn, or where access to the global list will be replaced	`[ "demoSite1", "demoSite2" ]`
Action	Optional	The operation to be performed on the global list with respect to the selected sites. The options are: Add (default): The global list will be made accessible for the the sites specified within the Site List. Remove: The global list will be no longer accessible for the sites specified within the Site List. Overwrite: All existing sites with access to the global list will be fully replaced by the new sites specified in the Site List.	Remove

Parameter Name

Required/Optional

Description

Sample Data

Global List Name

Required

The name of the global list.

demoGlobalList

Site List

Required

The sites where the global list access will be published or withdrawn, or where access to the global list will be replaced

[
  "demoSite1",
  "demoSite2"
]

Action

Optional

The operation to be performed on the global list with respect to the selected sites. The options are:

Add (default): The global list will be made accessible for the the sites specified within the Site List.
Remove: The global list will be no longer accessible for the sites specified within the Site List.
Overwrite: All existing sites with access to the global list will be fully replaced by the new sites specified in the Site List.

Remove

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

{
    "Status": "Successful", 
    "Data": { "Current Shared Sites":[Site1, Site2]}
}

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

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

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>",
    "Site List": "<Site List here>",
    "Action": "<Action 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	`string`	Required	The name of the global list.
Site List	`array<string>`	Required	The sites where the global list access will be published or withdrawn, or where access to the global list will be replaced
Action	`string`	Optional	The operation to be performed on the global list with respect to the selected sites. The options are: Add (default): The global list will be made accessible for the the sites specified within the Site List. Remove: The global list will be no longer accessible for the sites specified within the Site List. Overwrite: All existing sites with access to the global list will be fully replaced by the new sites specified in the Site List.

Sample Request

Sample Data

JSON

{
  "Username": "Admin",
  "Site": "Security Operations",
  "CommandParams": {
    "Global List Name": "demoGlobalList",
    "Site List": [
      "demoSite1",
      "demoSite2",
    ]
    "Action": "Overwrite"
  }
}

Response

Response Fields

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

Sample Response

JSON

{
    "error": "",
    "returnData": {
        "Status": "Successful",
        "Data": {
            "Current Shared Sites": [
                "demoSite1",
                "demoSite2",               
            ]
        }
    }
}