Searching:
0 results foundtenantTemplates/Post
POST /odata/tenantTemplates
Description
To create a new Tenant Manifest (template).
See the following for request and response details ‒
See Also
Request ‒ tenantTemplates/Post
Property | Type | Description | Mandatory |
name | String | The name of this Tenant Manifest (template). | |
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/tenantLogo | String | A link to the logo representing the Tenant to be used in the Axonize Portal. | |
settings/tenantDarkLogo | String | A link to the logo representing the Tenant to be used in the Axonize Portal when in Dark Theme mode. | |
settings/color | String | Specifies the color of the light theme used when displaying the Axonize Portal. The color is specified in Hex Color code format.
For example, white is #FFFFFF. |
|
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/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. | |
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/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.
https://en.wikipedia.org/wiki/List_of_tz_database_time_zones “timezone”:”Asia/Jerusalem” |
|
settings/security | Object | Currently, the only security option is captchaSettings, as described below. | |
settings/security captchaSettings | Object | The captcha settings. | |
settings/security captchaSettings/enabled | Boolean | Indicates whether captcha is enabled or disabled. | |
settings/security captchaSettings/authenticationAttemptsAllowed | Integer | The number of attempts you are allowed to solve this captcha. | |
settings/colorDark | String | Specifies the color of the dark theme used when displaying the Axonize Portal. The color is specified in Hex Color code format.
For example, black is #000000. |
|
settings/favicon | String | The Application custom icon that appears in the browser tab. | |
settings/loginLogo | String | The logo that displays on the Login page. | |
settings/title | String | The application title that appears in the browser tab. | |
settings/cssExternalFile | String | The custom *.css file that overrides Axonize’s CSS rules. | |
settings/hideLegacyDashboard | Boolean | When true, hides the default Axonize Dashboard. | |
settings/azureADConnect | Boolean | When true, enables the login with the user account. | |
settings/inviteEmail | String | Specifies the email details when inviting a user to Axonize. | |
inviteEmail/emailBody | String | The email body of the invitation email, in html code. | |
inviteEmail/emailSubject | String | The subject of the email. | |
resetPasswordEmail | String | Specifies the email details for resetting the Axonize password. | |
resetPasswordEmail/emailBody | String | The email body of the password-reset email, in html code. |
|
resetPasswordEmail/emailSubject | String | The subject of the email. | |
forgotPasswordEmail | String | Specifies the email details when the user forgot the Axonize password. | |
forgotPasswordEmail/emailBody | String | The email body of the forgot-password email, in html code. |
|
forgotPasswordEmail/emailSubject | String | The subject of the email. | |
reportEmail | String | Specifies the email details for receiving Axonize reports. | |
reportEmail/emailBody | String | The email body of the reports email, in html code. | |
reportEmail/emailSubject | String | The subject of the email. |
Example JSON tenantTemplates/Post Request
curl -X POST \
https://api.dev.axonize.com/odata/tenantTemplates/ \
-H ‘Accept: application/json, text/plain, */*’ \
-H ‘Content-Type: application/json’ \
-H ‘appId: 1aaf017c-b987-4f53-94d6-ad9afb8e4767’ \
-H ‘cache-control: no-cache’ \
-d ‘{
“name”: “tenantTemplate”,
“settings”:
{
“tenantLogo” : “Logo”,
“tenantDarkLogo” : null,
“color” : null,
“cultureInfo” : null,
“passwordPolicy” : null,
“reportPrefix” : null,
“reportColor” : null,
“timezone” : null,
“security” : null,
“colorDark” : null,
“favicon” : null,
“loginLogo” : null,
“title” : null,
“cssExternalFile” : null,
“hideLegacyDashboard” : null,
“azureADConnect” : null,
“inviteEmail” : null,
“resetPasswordEmail” : null,
“forgotPasswordEmail” : null,
“reportEmail” : null
}
}’
Response ‒ tenantTemplates/Post
All the same properties in the request are returned in the response. In addition, the response that is returned also contains the following properties –
Property | Type | Description |
id | String | A unique identifier for this Tenant Manifest (template) that is automatically generated. Please note that this ID is only intended for internal use by Axonize. |
appId | String | A unique identifier that is automatically generated by Axonize for this Application.
This property is used to link between other entities (such as Users and Devices) and this Application. |
createDate, createUser, updateDate, updateUser |
See Common Response Properties. |
Example JSON tenantTemplates/Post Response
Status 201 – Created
{
“@odata.context”: “https://10.9.0.103/odata/$metadata#TenantTemplates/$entity”,
“name”: “tenantTemplate”,
“id”: “5cc073c2e3b0cb26c4db5a0f”,
“appId”: “1aaf017c-b987-4f53-94d6-ad9afb8e4767”,
“createDate”: “2019-04-24T14:33:38.9050529Z”,
“createUser”: null,
“updateDate”: “2019-04-24T14:33:38.9050529Z”,
“updateUser”: null,
“settings”: {
“tenantLogo”: “Logo”,
“tenantDarkLogo”: null,
“color”: null,
“cultureInfo”: null,
“reportPrefix”: null,
“reportColor”: null,
“timezone”: null,
“colorDark”: null,
“favicon”: null,
“loginLogo”: null,
“title”: null,
“cssExternalFile”: null,
“hideLegacyDashboard”: null,
“azureADConnect”: null,
“passwordPolicy”: null,
“security”: null,
“inviteEmail”: null,
“resetPasswordEmail”: null,
“forgotPasswordEmail”: null,
“reportEmail”: null
}
}