Create Tenant Site
LAST UPDATED: AUG 12, 2024
Executes in the master instance to create 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 | The tenant Name for the site | d3localtest_connection |
Site Name | Required | The name for the new site. | sample new create site122 |
Site Description | Optional | The description for the new site. | new site description |
Site Type | Required | The type for the new site, with available options being:
The default type is Client. | Client |
Shared Connection | Optional | Whether to designate the internal site being created as the recipient site. The default value is False. | False |
Is Active | Required | Whether the new site is active. Setting this to False will make the site offline and unusable. The default value is True. | True |
Time Zone | Required | The time zone for the new site. The default setting is Greenwich Mean Time. | (GMT-08:00) Pacific Standard Time |
Language | Optional | The language for the new site. The default value is English. | Default(English) |
Is Master | Required | Whether the new site is a master site. The default value is False. | False |
Output
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
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
{
"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 |
---|---|---|---|
Username |
| Required | The username of your D3 SOAR account. |
Site |
| Required | The D3 SOAR site to run the remote command. |
Region |
| Required | The region of the tenant |
Tenant Name |
| Required | The tenant Name for the site |
Site Name |
| Required | The name for the new site. |
Site Description |
| Optional | The description for the new site. |
Site Type |
| Required | The type for the new site, with available options being:
The default type is Client. |
Shared Connection |
| Optional | Whether to designate the internal site being created as the recipient site. The default value is False. |
Is Active |
| Required | Whether the new site is active. Setting this to False will make the site offline and unusable. The default value is True. |
Time Zone |
| Required | The time zone for the new site. The default setting is Greenwich Mean Time. |
Language |
| Optional | The language for the new site. The default value is English. |
Is Master |
| Required | Whether the new site is a master site. The default value is False. |
Sample Request
SAMPLE DATA
{
"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 |
| The error message if the API request has failed. |
returnData |
| The return data from the API request. |
rawData |
| The raw data from the API request. |
contextData |
| The context data from the API request. |
Sample Response
{
"error":"",
"returnData":"Successful",
"rawData":{
"TenantSite": "test53",
"TenantSiteId": 100060,
"IsActive": true
},
"contextData":{
"success": true,
"message": "Successfully added the site:sample new create site122",
"data": 100027
}
}