# Deep Security Manager REST API

## Name: tenant

A structure containing information about Tenant.

During tenant creation, only name, language, country, and time zone are required. If neither `allModulesVisible` nor `modulesVisible` are set at this time, the server will default to all modules being visible. Also, if `hideUnlicensedModules` is not set during tenant creation, a default value of `true` is assumed.

JSON Example:
    {"tenant":
     {
       "agentInitiatedActivationPassword": String,
       "allModulesVisible": Boolean,
       "country": String,
       "databaseServerID": Number,
       "demoMode": Boolean,
       "description": String,
       "guid": String,
       "hideUnlicensedModules": Boolean,
       "language": String,
       "licenseMode": String,
       "modulesVisible": [String],
       "name": String,
       "state": String,
       "tenantID": Number,
       "timeZone": String,
     }
    }

Elements
Name | Type | Required | Default Value | Description
--- | --- | --- | --- | ---
agentInitiatedActivationPassword | String | No | `` | The password used during agent-initiated activation Agents can be activated from the command line using the syntax: `dsa_control /a dsm://{host}:4120/ tenantID:{guid} tenantPassword:{agentInitiatedActivationPassword}`
allModulesVisible | Boolean | No | `` | Whether or not all modules are visible to the tenant. If this value is set to `true` then the value of `modulesVisible` is ignored.
country | String | Yes | `` | The tenant country (required for tenant creation). Allowed countries are those for which Deep Security Manager has been localized, typically: US - used when language="en" for US English JP - used when language="jp" for Japanese CN - used when language="zh" for Chinese If the combination of language and country does not match any of the locales supported by Deep Security Manager then the tenant will be created using the system's default locale.
databaseServerID | Number | No | `` | The ID of the tenant database server. `null` implies automatic selection, 0 implies the primary database server.
demoMode | Boolean | No | `` | Whether or not demo mode is enabled for the tenant.
description | String | No | `` | A text description of the tenant; this is a free-form text field that can be used to describe the tenant or attach information to them.
guid | String | No | `` | Return the Tenant GUID, required for agent-initiated activation.
hideUnlicensedModules | Boolean | No | `` | Whether or not all unlicensed modules are hidden. During tenant creation, if this value is not specified, a default value of `true` is used.
language | String | Yes | `` | The tenant language (required for tenant creation). Allowed languages are those in which Deep Security Manager has been localized, typically: en - English ja - Japanese zh - Chinese If the combination of language and country does not match any of the locales supported by Deep Security Manager then the tenant will be created using the system's default locale.
licenseMode | String | No | `` | License Mode gives the status of the license for the selected tenant. This is only reported as information and cannot be set during tenant create or update.
modulesVisible | zero or N[String] | No | `` | The list of modules visible to the tenant. Possible values are the following module codes: AM - Anti-Malware WRS - Web Reputation FW - Firewall DPI - Intrusion Prevention IM - Integrity Monitoring LI - Log Inspection AC - Application Control SAP - SAP Ignored if allModulesVisible is `true`
name | String | Yes | `` | The tenant name (required for tenant creation).
state | String | No | `` | The tenant state, one of: UNDEFINED CREATED ACTIVE SUSPENDED PENDING_DELETION DB_UPGRADE_FAILURE The state must not be specified when creating a tenant. The update tenant API only can change state from ACTIVE to SUSPENDED, or from SUSPENDED to ACTIVE.
tenantID | Number | No | `` | The tenant ID.
timeZone | String | Yes | `` | The tenant time zone (required for tenant creation). Time zones should be specified using identifiers such as those returned from Java's `java.util.TimeZone` class. For example, "US/Eastern".

Copyright © 2017 Trend Micro Inc. All Rights Reserved.