Update Tenant Site Status
LAST UPDATED: AUG 13, 2024
Updates the status of a tenant site for a specified region.
Implementation | System |
Command Category | System Utility |
Tags | MULTITENANCY |
Inputs
Parameter Name | Required/Optional | Description | Sample Data |
---|---|---|---|
Tenant Region | Required | The region of the tenant. | AMER |
Tenant Name | Required | The tenant name for the site. | Tenant name for the site |
Tenant Site | Required | The name of the tenant site. | Tenant Site1 |
Offboarding Actions | Required | The offboarding actions for a client site:
| Suspend |
Enable Reactivation | Optional | Whether to restore automation rules and integration connections to their most recent active states (nothing prior). The default setting is True. | True |
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/UpdateTenantSiteStatus
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": {
"Tenant Region": "<Tenant Region here>",
"Tenant Name": "<Tenant Name here>",
"Tenant Site": "<Tenant Site here>",
"Offboarding Actions": "<Offboarding Actions here>",
"Enable Reactivation": "<Enable Reactivation 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. |
Tenant Region |
| Required | The region of the tenant. |
Tenant Name |
| Required | The tenant name for the site. |
Tenant Site |
| Required | The name of the tenant site. |
Offboarding Actions |
| Required | Offboarding actions of client site:
|
Enable Reactivation |
| Optional | Whether to restore automation rules and integration connections to their states prior to the site's last deactivation. The options are:
Reactivation can only recall the most recent active state, and nothing prior. |
Sample Request
SAMPLE DATA
{
"Username": "Admin",
"Site": "Security Operations",
"CommandParams": {
"Tenant Region": "AMER",
"Tenant Name": "AMER Tenant",
"Tenant Site": "Tenant Site1",
"Offboarding Actions": "suspend",
"Enable Reactivation": "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. |
Sample Response
{
"error": "",
"returnData": {
"Status": "Successful"
}
}