Sync Connection

LAST UPDATED: AUG 09, 2024

Enables the synchronization of connection from the master to the tenant instance(s).

Implementation	System
Command Category	System Utility
Tags	CONNECTION MULTITENANCY

Inputs

Parameter Name	Required/Optional	Description	Sample Data
Sync All Shared	Optional	Whether to synchronize all available connections.	False
Connection Info	Optional	The specific connection(s) to synchronize.	CODE `[ { "Integration Name": "TestIntegration", "Connection Name": "TestConnection", "Site": "Shared to internal sites" }, { "ConnectionId": 123 } ]`
Tenant Region	Required	The region of the tenant.	AMER
Tenant Name	Required	The name of the tenant.	TestTenant
Tenant Site	Required	The tenant site to synchronize.	TenantSite

READER NOTE

One of Sync All Shared or Connection Info must receive input. If both receive input, the D3 system will ignore the Connection Info input.

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

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": {
    "allTenant": <allTenant here>,
    "Region": <Region here>,
    "TenantName": <Tenant Name here>
    "Sync All Shared": <Sync All Shared here>,
    "Connection Info": <Connection Info here>,
    "Tenant Region": <Tenant Region here>,
    "Tenant Name": <Tenant Name here>,
    "Tenant Site": <Tenant Sitehere>,
  }
}

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.
Sync All Shared	`boolean`	Optional	The option to share all tagged connections or only the ones specified in the Connection Info field.
Connection Info	`array<JSON Object>`	Optional	Information about the connection to be synchronized.
Tenant Region	`string`	Required	The region of the tenant.
Tenant Name	`string`	Required	The name of the tenant.
Tenant Site	`string`	Required	The tenant site to synchronize.

Sample Request

SAMPLE DATA

JSON

{
  "Username": "Admin",
  "Site": "Security Operations",
  "CommandParams": {
    "Sync All Shared": "False",
    "Connection Info": [
      {
        "Integration Name": "TestIntegration",
        "Connection Name": "TestConnection",
        "Site": "Shared to internal sites"
      },
      {
        "ConnectionId": 123
      }
    ],
    "Tenant Region": "AMER",
    "Tenant Name": "TestTenant",
    "Tenant Site": "TenantSite"
  }
}

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"
}