Property | Type | Description | Mandatory |
|---|---|---|---|
active | Boolean | Specifies whether the Tenant is active, meaning that it can be used – True/False. | |
appId | String | The unique identifier of this Tenant’s Master Application that is generated automatically. A Master Application is the Application that enables the management of all/any of the Applications within a Tenant and all its Sub-tenants. Each Tenant has a single Master Application. | Y |
subdomain | String | The subdomain is the unique identifier of the Tenant and is also used as the Tenant URL, [tenant subdomain].axonize.com. | Y |
parentId | String | Specifies the ID of the parent Tenant of this Tenant. This property enables you to define Sub-tenants. This property is mandatory because external users are only allowed to create sub‑Tenants. | Y |
name | String | The Tenant’s name. | Y |
ancestors | Array | Lists the IDs of the ancestor Tenants (parents, parents of parents and so on) of this Tenant, in no particular order. | |
parentId | String | Specifies the ID of the parent Tenant of this Tenant. This property enables you to define Sub-tenants. | |
urls | Array of Strings | Enter your own URL here in order to enable this Tenant to be accessed via this URL instead of the default URL provided by IoT Platform , which uses tenantname.axonize.com. Important Notes ‒ These URLs must be coordinated with IoT Platform support in order to be handled properly. Make sure to contact IoT Platform support and get their authorization to use specific URLs. | |
applications | Array of Applica-tions | Not in use. | |
additionalProperties | Array of serviceProperty | Not in use. | |
region | String | Not in use. | |
logo | String | Not in use (deprecated). A link to the logo representing the Tenant to be used in the IoT Platform Portal. | |
color | String | Not in use (deprecated). Specifies the color of the light theme used when displaying the IoT Platform Portal. The color is specified in Hex Color code format. For example, white is #FFFFFF. | |
colorDark | String | Not in use (deprecated). Specifies the color of the dark theme used when displaying the IoT Platform Portal. The color is specified in Hex Color code format. For example, black is #000000. | |
cultureInfo | String | Not in use (deprecated). Default localization information of the Application. These standard options include the language of the Application and are described at https://msdn.microsoft.com/en-us/library/system.globalization.cultureinfo(vs.71).aspx. | |
reportPrefix | String | Not in use (deprecated). The name of the report generated for this Tenant. | |
reportColor | String | Not in use (deprecated). Specifies the background color of the generated report. The color is specified in Hex Color code format. For example, white is #FFFFFF. | |
timezone | String | Not in use (deprecated). The default timezone of the Tenant. “timezone”:”Asia/Jerusalem” | |
passwordPolicy | Not in use (deprecated). The password policy for logging into this Tenant. If a Sub-tenant has a password policy, then it overrides the Tenant. If the Application of this Tenant has a password policy, then it overrides the Tenant’s password Policy. See below. | ||
passwordPolicy/maxPasswordLength | Integer | Not in use (deprecated). The maximum length of the password. | |
passwordPolicy/minPasswordLength | Integer | Not in use (deprecated). The minimum length of the password. | |
passwordPolicy/numberOfDifferentCharTypes | Integer | Not in use (deprecated). The minimum number of characters in the password that must be different from each other. | |
passwordPolicy/mustBeDifferentFromUserName | Boolean | Not in use (deprecated). True if the password must be different than the user name. | |
security | Object | Not in use (deprecated). Currently, the only security option is captchaSettings, as described below. | |
captchaSettings | Object | Not in use (deprecated). The captcha settings. | |
captchaSettings/Enabled | Boolean | Not in use (deprecated). Indicates whether captcha is enabled or disabled. | |
captchaSettings/authenticationAttemptsAllowed | Integer | Not in use (deprecated). The number of attempts you are allowed to solve this captcha. | |
templateId | String | Specifies the ID of the Tenant Manifest (template) used by the Tenant. If no value is specified, the default value is automatically used. | |
settings | Object | Specifies the settings to be applied in the Tenant Manifest (template). These settings override the values in the Tenant Manifest (template) assigned to the Tenant. | |
settings/logo | String | A link to the logo representing the Tenant to be used in the IoT Platform Portal. | |
settings/color | String | Specifies the color of the light theme used when displaying the IoT Platform Portal. The color is specified in Hex Color code format. For example, white is #FFFFFF. | |
settings/colorDark | String | Specifies the color of the dark theme used when displaying the IoT Platform Portal. The color is specified in Hex Color code format. For example, black is #000000. | |
settings/cultureInfo | String | Default localization information of the Application. These standard options include the language of the Application and are described at https://msdn.microsoft.com/en-us/library/system.globalization.cultureinfo(vs.71).aspx. | |
settings/reportPrefix | String | The name of the report generated for this Tenant. | |
settings/reportColor | String | Specifies the background color of the generated report. The color is specified in Hex Color code format. For example, white is #FFFFFF. | |
settings/timezone | String | The default timezone of the Tenant. “timezone”:”Asia/Jerusalem” | |
settings/passwordPolicy | The password policy for logging into this Tenant. If a Sub-tenant has a password policy, then it overrides the Tenant. If the Application of this Tenant has a password policy, then it overrides the Tenant’s password Policy. See below. | ||
settings/passwordPolicy/maxPasswordLength | Integer | The maximum length of the password. | |
settings/passwordPolicy/minPasswordLength | Integer | The minimum length of the password. | |
settings/passwordPolicy/numberOfDifferentCharTypes | Integer | The minimum number of characters in the password that must be different from each other. | |
settings/passwordPolicy/mustBeDifferentFromUserName | Boolean | True if the password must be different than the user name. | |
settings/security | Object | Currently, the only security option is captchaSettings, as described below. | |
settings/captchaSettings | Object | The captcha settings. | |
settings/captchaSettings/Enabled | Boolean | Indicates whether captcha is enabled or disabled. | |
settings/captchaSettings/authenticationAttemptsAllowed | Integer | The number of attempts you are allowed to solve this captcha. |