Create Or Update Connection By Clone

Create a task and assign to a user.

Implementation	System
Command Category	System Utility
Tags	MULTITENANCY CONNECTION

Inputs

Parameter Name	Required/Optional	Description	Sample Data
Connection	Optional	Connection to clone	`Test Site - testIntegration - testConnection`
IsShared	Optional	Set if the connection will be able to be shared to tenant. This must be set to true to edit tenant region, tenant name, and tenant site, else those input will be ignored	`True`
Tenant Region	Optional	Region of the tenant	`AMER`
Tenant Name	Optional	Name of the tenant	`Test Tenant`
Tenant Site	Optional	Site of the tenant	`Test Tenant Site`
Update Fields	Optional	Fields to change for the created clone connection. Fields not entered here just take the value of the selected connection.	CODE `{ "ConnectionName": "Test", "Description": "A test connection", "Site": "Test Master Site", "Fields": { "Url": "www.google.com", "User Type": "Account", "User": "AccountName" } }`

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

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

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": {
    "Connection": "<Connection here>",
    "IsShared": "<IsShared here>",
    "Tenant Region": "<Tenant Region here>",
    "Tenant Name": "<Tenant Name here>",
    "Tenant Site": "<Tenant Site here>",
    "Update Fields": "<Update Fields here>"
  }
}

Body Parameters

Parameter Name	Type	Required/Optional	Description
Username	`Text`	Required	The username of your D3 SOAR account.
Site	`Text`	Required	The D3 SOAR site to run the remote command.
Connection	`Text`	Optional	Connection to clone.
IsShared	`Text`	Optional	Set if the connection will be able to be shared to tenant. This must be set to true to edit tenant region, tenant name, and tenant site, else those input will be ignored
Tenant Region	`Text`	Optional	Region of the tenant
Tenant Name	`Text`	Optional	Name of the tenant
Tenant Site	`DateTime`	Optional	Site of the tenant
Update Fields	`Text`	Optional	Fields to change for the created clone connection. Fields not entered here just take the value of the selected connection.

Sample Request

SAMPLE DATA

JSON

{
  "Username": "Admin",
  "Site": "Security Operations",
  "CommandParams": {
    "Connection": "Test Site - testIntegration - testConnection",
    "IsShared": "True",
    "Tenant Region": "AMER",
    "Tenant Name": "Test Tenant",
    "Tenant Site": "Test Tenant Site",
    "Update Fields": {
      "ConnectionName": "Test",
      "Description": "A test connection",
      "Site": "Test Master Site",
      "Fields": {
        "Url": "www.google.com",
        "User Type": "Account",
        "User": "AccountName"
      }
    }
  }
}

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.

Sample Response

JSON

{
    "error": "",
    "returnData": "Successful"
    
}