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 |
CODE
|
Action | Optional | The operation to be performed on the global list with respect to the selected sites. The options are:
| Remove |
Output
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
{
"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 |
| Required | The username of your D3 SOAR account. |
Site |
| Required | The D3 SOAR site to run the remote command. |
Global List Name |
| Required | The name of the global list. |
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 |
Action |
| Optional | The operation to be performed on the global list with respect to the selected sites. The options are:
|
Sample Request
SAMPLE DATA
{
"Username": "Admin",
"Site": "Security Operations",
"CommandParams": {
"Global List Name": "demoGlobalList",
"Site List": [
"demoSite1",
"demoSite2",
]
"Action": "Overwrite"
}
}
Response
Response Fields
Field Name | Type | Description |
---|---|---|
error |
| The error message if the API request has failed. |
returnData |
| The return data from the API request. |
Sample Response
{
"error": "",
"returnData": {
"Status": "Successful",
"Data": {
"Current Shared Sites": [
"demoSite1",
"demoSite2",
]
}
}
}