Update Tenant Site Status | docs.d3security

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: Stops all scheduled jobs and suspends the site from ingesting new events or incidents. Disable: Sets the site to an inactive state, halting, inactivating, and hiding all scheduled jobs, dashboards, automation rules, and connections. Enable: Reactivates a site from a suspended or inactive state.	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

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

{
    "Status": "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

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

JSON

{
  "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	`string`	Required	The username of your D3 SOAR account.
Site	`string`	Required	The D3 SOAR site to run the remote command.
Tenant Region	`string`	Required	The region of the tenant.
Tenant Name	`string`	Required	The tenant name for the site.
Tenant Site	`string`	Required	The name of the tenant site.
Offboarding Actions	`string`	Required	Offboarding actions of client site: Suspend: Stops all scheduled jobs and suspends the site from ingesting new events or incidents. Disable: Sets the site to an inactive state, halting, inactivating, and hiding all scheduled jobs, dashboards, automation rules, and connections. Enable: Reactivates a site from a suspended or inactive state.
Enable Reactivation	`boolean`	Optional	Whether to restore automation rules and integration connections to their states prior to the site's last deactivation. The options are: True (default): Return to their most recent active state when the site is enabled False: Remain inactive Reactivation can only recall the most recent active state, and nothing prior.

Sample Request

Sample Data

JSON

{
  "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	`string`	The error message if the API request has failed.
returnData	`JSON Object`	The return data from the API request.

Sample Response

JSON

{
    "error": "",
    "returnData": {
        "Status": "Successful"
    }
}