Remove Global List from Site

LAST UPDATED: AUG 15, 2024

Removes a global list from a site. A user cannot access global lists within the site from which they have been removed.

READER NOTE

This command will not delete the global list. Users with the Global List permission are able to delete global lists using the button located at the top right-hand corner.

Administrator accounts are used to configure Global List permissions under Organization Management > Roles > <a specific user> > Details > Configuration Modules > Global List.

Implementation	System
Command Category	System Utility
Tags	GLOBAL LIST

Inputs

Parameter Name	Required/Optional	Description	Sample Data
List Name	Required	The name of the global list.	demoGlobalList

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

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

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": {
    "List Name": "<List Name here>"
  }
}

Body Parameters

Parameter Name	Type	Required/Optional	Description
Username	`string`	Required	The username of your D3 SOAR account.
Site	`string`	Required	The site for which the global list will no longer be shared.
List Name	`string`	Required	The name of the global list.

Sample Request

SAMPLE DATA

JSON

{
  "Username": "Admin",
  "Site": "Security Operations",
  "CommandParams": {
    "List Name": "demoGlobalList"
  }
}

Response

Response Fields

Field Name	Type	Description
result	`string`	The HTML representation of the returned data.
error	`string`	The error message if the API request has failed.
returnData	`string`	The return data from the API request.

Sample Response

JSON

{
    "result": "<div>Successfully removed. </div>",
    "error": "",
    "returnData": "Succeed"
}