Create Tenant Site

This utility command is executed in the Master instance and creates a site in the tenant instance.

Implementation	System
Command Category	System Utility
Tags	MULTITENANCY SITE

Inputs

Parameter Name	Required/Optional	Description	Sample Data
Region	Required	The region of the tenant	`AMER`
Tenant Name	Required	Tenant Name for the site	`d3localtest_connection`
Site Name	Required	Specify the site name for the new site.	`sample new create site122`
Site Description	Optional	Specify the site description for the new site.	`new site description`
Site Type	Required	Specify the site type for the new site. . The default value is client.	`Client`
Shared Connection	Required	Specify if share connection for the new site. The default value is false.	`False`
Is Active	Required	Specify if active for the new site. The default value is true.	`True`
Time Zone	Required	Specify if Time Zone for the new site. The default value is Greenwich Mean Time.	`(GMT-08:00) Pacific Standard Time`
Language	Optional	Specify if the language for the new site. The default value is English.	`Default(English)`
Is Master	Required	Specify if it is master site for the new site. The default value is false.	`False`

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

Context Data

The response data from the utility command.

SAMPLE DATA

JSON

{
    "success": true,
    "message": "Successfully added the site:sample new create site122",
    "data": 100027
}

Raw Data

The response data from the utility command.

SAMPLE DATA

CODE

{
    "TenantSite": "test53",
    "TenantSiteId": 100060,
    "IsActive": true
}

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

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": {
    "Region": "<Region here>",
    "Tenant Name": "<Tenant Namehere>",
    "Site Name": "<Site Name here>",
    "Site Description": "<Site Description here>",
    "Site Name": "<SiteName here>",
    "Site Description": "<Site Description here>",
    "Site Type": "<Site Type here>",
    "Shared Connection": "<Shared Connection here>",
    "Is Active": "<Is Active here>",
    "Time Zone": "<Time Zone here>",
    "Language": "<Language here>",
    "Is Master": "<Is Master here>"
  }
}

Body Parameters

Parameter Name	Type	Required/Optional	Description
Region	`Text`	Required	The region of the tenant
Tenant Name	`Text`	Required	Tenant Name for the site
Site Name	`Text`	Required	Specify the site name for the new site.
Site Description	`Text`	Optional	Specify the site description for the new site.
Site Type	`Text`	Required	Specify the site type for the new site. . The default value is client.
Shared Connection	`Text`	Required	Specify if share connection for the new site. The default value is false.
Is Active	`DateTime`	Required	Specify if active for the new site. The default value is true.
Time Zone	`DateTime`	Required	Specify if Time Zone for the new site. The default value is Greenwich Mean Time.
Language	`Text`	Optional	Specify if the language for the new site. The default value is English.
Is Master	`Text`	Required	Specify if it is master site for the new site. The default value is false.

Sample Request

SAMPLE DATA

JSON

{
  "Username": "Admin",
  "Site": "Security Operations",
  "CommandParams": {
    "Region": "AMER",
    "Tenant Name": "d3localtest_connection",
    "Site Name": "sample new create site122",
    "Site Description": "new site description",
    "Site Type": "Client",
    "Shared Connection": "False",
    "Is Active": "True",
    "Time Zone": "(GMT-08:00) Pacific Standard Time",
    "Language": "Default(English)",
    "Is Master": "False"
  }
}

Response

Response Fields

Field Name	Type	Description
error	`Text`	The error message if the API request has failed.
returnData	`Text`	The return data from the API request.
contextData	`JSON Object`	The context data from the API request.
rawData	`JSON Object`	The raw data from the API request.

Sample Response

JSON

{
    "error":"",
    "returnData":"Successful",
    "rawData":{
      "TenantSite": "test53",
      "TenantSiteId": 100060,
      "IsActive": true
    },
    "contextData":{
      "success": true,
      "message": "Successfully added the site:sample new create site122",
      "data": 100027
    }
}