Create Or Update Connection By Clone

LAST UPDATED: AUG 12, 2024

Creates a clone of the connection and overwrites values that are passed in the parameter. Updates the existing connection if a connection with that Name, Region, TenantName, and TenantSite already exist on the site.

Implementation	System
Command Category	System Utility
Tags	MULTITENANCY CONNECTION

Inputs

Parameter Name	Required/Optional	Description	Sample Data
Connection	Required	The integration connection to be cloned.	Test Site - testIntegration - testConnection
IsShared	Required	Whether the integration connection can be shared with the tenant. True: Allows editing of the tenant region, tenant name, and tenant site. False: Inputs for these three parameters will be ignored.	True
Tenant Region	Required	The region of the tenant.	AMER
Tenant Name	Required	The name of the tenant.	Test Tenant
Tenant Site	Required	The site of the tenant.	Test Tenant Site
Update Fields	Optional	The fields to be modified in the cloned connection. Fields not specified here will retain the values from the selected connection.	CODE `{ "ConnectionName": "Test", "Description": "A test connection", "Site": "Test Master Site", "Fields": { "Url": "http://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

JSON

Successful

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	`string`	Required	The username of your D3 SOAR account.
Site	`string`	Required	The D3 SOAR site to run the remote command.
Connection	`string`	Required	The integration connection to be cloned.
IsShared	`boolean`	Required	Whether the integration connection can be shared with the tenant. True: Allows editing of the tenant region, tenant name, and tenant site. False: Inputs for these three parameters will be ignored.
Tenant Region	`string`	Required	The region of the tenant.
Tenant Name	`string`	Required	The name of the tenant.
Tenant Site	`string`	Required	The site of the tenant.
Update Fields	`JSON Object`	Optional	The fields to be modified in the cloned connection. Fields not specified here will retain the values from 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"
}