Deactivating the tenant

Allows you to perform the following actions depending on the tenant type and the specified parameters:

• For a complete tenant type:
  • Change the tenant status to Inactive.
  • Change the status of the policies that disable tenant protection and are located in the Multitenancy KSV LA → <tenant name> folder to Active policy. As a result, protection of all tenant virtual machines is disabled. The status of the policies that enable tenant protection changes to Inactive policy.
  • Create the policies that disable tenant protection, if they are missing in the Multitenancy KSV LA → <tenant name> folder.
• For a simple tenant type: only change the tenant status to Inactive.

Method:

POST /api/2.0/virtualization/tenants/{tenant ID}/deactivate

where:

{tenant ID} – tenant identifier in the Integration Server database (required parameter).

If the policies, that disable tenant protection, are missing in the Multitenancy KSV LA → <tenant name> folder, they are created automatically.

The request is executed asynchronously, REST API returns identifier of the ChangeTenantActivation task. Using the task, you can monitor the progress of the tenant status changing procedure. When the task execution completes, the result field displays confirmation that the tenant status is changed (true) or an error message.

Return codes:

• 202 (Accepted) – the request is accepted for execution. The response returns the identifier of the ChangeTenantActivation task.
• 403 (Forbidden) – access to the resource is denied.

Error codes in the task:

• VIRMT_TenantWithSpecifiedIdNotFound – the tenant with the specified identifier is not found in the Integration Server database.
• KSC_ServiceNotConfigured – Kaspersky Security Center connection settings are not specified.

Page top