Allows you to get information about the tenant from the Integration Server database.
Method:
GET /api/2.0/virtualization/tenants/{tenant ID}
where:
{tenant ID} – tenant identifier in the Integration Server database (required parameter).
In case of successful completion of the request, the REST API returns the following information about the tenant:
<tenant id="{ID}" created="{date and time}" updated="{date and time}">
<name>{name}</name>
<description>{description}</description>
<userData><![CDATA[{additional information}]]></userData>
<!-- Data in the vKsc section is available only for a complete tenant type -->
<vKsc id="{ID}">
<user>
<name>{administrator}</name>
</user>
</vKsc>
<status>{status}</status>
<type>{tenant type}</type>
</tenant>
where:
tenant id="{ID}" – tenant identifier in the Integration Server database.created="{date and time}" – date and time when the tenant was registered in the Integration Server database in YYYY-MM-DDThh:mm:ss format.updated="{date and time}" – date and time when the tenant data was updated in the Integration Server database in YYYY-MM-DDThh:mm:ss format.{name} – tenant name specified when the tenant was created.{description} – tenant description.{additional information} – additional information about the tenant stored in the Integration Server database.vKsc id="{ID}" – identifier assigned to the tenant virtual Administration Server in Kaspersky Security Center.{administrator} – name of the administrator of the tenant virtual Administration Server.{status} – current tenant status: Active or Inactive.{tenant type} – tenant type: Complete or Simple.Return codes:
200 (OK) – request completed successfully. The response returns the tenant information.403 (Forbidden) – access to the resource is denied.404 (Not Found) VIRMT_TenantWithSpecifiedIdNotFound – tenant with the specified identifier is not found in the Integration Server database.