TenantRegistrationRequest Object
Contains information about a request to add a tenant to the API Platform.
This object is used by the following operation:
- POST /platform/subscriptions (in the request)
The properties included in the TenantRegistrationRequest object are listed below.
| Property | Type | Description |
|---|---|---|
| TenantID | FedmemberID |
Unique ID for a specific tenant. Same as TenantID. In this model object, TenantID is the FedmemberID. Required. When choosing this value, it's best to choose an ID that's all lowercase, and as short as possible, since it's used in many other IDs, URLs, and message payload content. Keep it simple, and do not include any special characters. |
| TenantName | string | Name of the tenant. If this value isn't provided, the platform uses the value provided for the TenantID as the TenantName. |
| ApiAddress | string | The base URL of the tenant. This is the default address from which the tenant is accessed. Multiple additional virtual hostnames are allowed, but the hostname provided in this property is the primary hostname. Corresponds to the --address parameter in the installation Jython script. |
| PortalAddress | string | The base URL of the tenant and also the context in which the API Platform is running. This is the full URL that will be used in the browser when accessing the UI. Corresponds to the --consoleAddress parameter in the installation Jython script. |
| DefaultTheme | string |
Name for the default theme for the tenant UI. Optional. Default: default. Note: Default Theme is deprecated in 2020.1.0. |
| DefaultThemeImpl | string | Name for the default themeimpl value for the tenant UI. Optional. Default: default. |
| AdditionalVirtualHosts | string[ ] | Optional: One or more additional virtual hosts for the tenant. |
| FwdProxyAllowedHosts | string[ ] | Optional: one or more additional hosts allowed as proxy addresses for APIs on the tenant. |
| DefaultUserAccounts | TenantUserAccount[ ] |
Contains information about a user account for a tenant administrator. One or more. Corresponds to the --email parameter in the installation Jython script. |
| PasswordForDefaultUsers | string | Optional: Default password for the tenant administrator. If you specify a password, and include multiple email addresses, all tenant administrators will have the same password for first login. If the password is not specified, the platform generates a random password, unique to each user. The password is sent to the specified email address in the initial email notification. |
| ESIndexName | string | Optional: the name of the Elasticsearch index. This is only needed if you're using some advanced options in a larger deployment, to have a separate, independent Elasticsearch index for each tenant. Corresponds to the --esIndexName parameter in the installation Jython script. |
| SupportEmailAddress | string | The email address that users should contact for help with any issues in the tenant. This address is used in some links in tenant pages; for example, in the footer template for platform pages. Corresponds to the --consoleAddress parameter in the installation Jython script. |
| NotificationsSenderEmailAddress | string | The From email address used when notification emails are sent out from the tenant. |
| ApiEndpointCName | string |
The CNAME for the API endpoint, that will be used in the Proxy URL path for APIs on the tenant (gateway hostname) Corresponds to the --cname parameter in the installation Jython script. |
| CDNRoot | string | Optional: The root URL for the tenant's CDN (content delivery network). Leave this property out if the tenant does not have a CDN. Corresponds to the --cdnRoot parameter in the installation Jython script. |
| DocumentDomain | string | Required only if CDNRoot is used: the domain for documents on the CDN. Corresponds to the --documentDomain parameter in the installation Jython script. |
| TenantOrgKey | string | Optional: An existing OrganizationKey to use for the tenant, if applicable. Corresponds to the --orgkey parameter in the installation Jython script. |
| AnalyticsAccountID | string | Optional: Account ID for the Google Analytics account to be used on the tenant. |
| DeploymentZoneContainerKey | string | The container key for the default deployment zone for a new tenant. |
| LaaSIntegrationSupport | string | Indicates whether the Lifecycle Manager integration feature is turned on. For valid values, see LaaSIntegrationSupport values. Optional. |