TenantProperties Object

Contains information about basic properties for the current tenant.

This object is used by the following operations:

The properties included in the TenantProperties object are listed below.

Property Type Description
DefaultTheme string

The name given to the Default Theme for the current tenant.

Note: Default Theme is deprecated in 2020.1.0.

ConsoleAddress string The console address base URL for the current tenant.
ProxyApiUrl string The URL for the proxy API, if applicable.
Themes Theme[ ]

Contains information about a theme defined for a tenant on the platform.

One or more.

TenantID FedmemberID

Unique ID for a specific tenant. Same as TenantID.

In this model object, TenantID is the FedmemberID.

SiteAdminGroupID string The unique GroupID for the Site Admin group on the platform.
TenantBusinessID string The unique ID for the tenant business.
TenantBusinessKey string The same as the TenantOrgKey value: An existing OrganizationKey to use for the tenant, if applicable. Corresponds to the --orgkey parameter in the installation Jython script.
BusinessAdminGroupID string The unique GroupID for the Business Admin group on the platform.
TenantName  

A friendly name for the tenant, for use in certain scenarios such as email messages.

Corresponds to the tenantName element in the installation Jython script.

ContactEmailAddress string

Optional. The email address used in any "contact us" context for the Community Manager developer portal, including certain emails and notifications that include contact information.

Corresponds to the contactEmailAddress element in the installation Jython script.

FromEmailAddress string

Optional. The email address displayed in the "From" field for email notifications sent out by the platform.

Corresponds to the fromEmailAddress element in the installation Jython script.

AnalyticsAccountID string Optional. Google Analytics Account ID. Adds Google Analytics automatically to site pages.
SupportedThemes SupportedTheme[ ] Contains information about supported themes available on the platform.
LaaSIntegrationSupport string Indicates whether the Lifecycle Manager integration feature is turned on. For valid values, see LaaSIntegrationSupport values. Optional.
ForwardProxyAllowedHosts string[ ] Optional. In a scenario where forward proxy activity is limited to one or more specified hosts, those hosts are specified in this property. Any other hosts are rejected as unauthorized, with a message that the host is not allowed. To allow all, use the asterisk wildcard (*). To allow multiple hosts, use a comma separator; for example, host1,host2,host3. Corresponds to the following setting in the Community Manager developer portal: Administration > Site > Limit forward proxy feature to allow only these hosts.