Tenant Object

Contains information about a tenant on the API Platform.

This object is used by the following operations:

The properties included in the Tenant object are listed below.

Property Type Description
FedMemberID FedmemberID Unique ID for a specific tenant. Same as TenantID.
TenantName string Name of the tenant.
Description string Description of the tenant
AdminGroupID string The unique ID for the Admin Group associated with the tenant.
AvatarURL anyURI URL for the avatar uploaded for the resource, if any. Used only in response messages.
Business Business Contains information about a business on the platform.
IndexTargets string[ ]

This property was added in case anyone wants to use Compass during the transition from 7.2 to 8.x. One or or more valid targets for the search index. Valid values:

  • elastic (for versions 7.2 and later)
  • compass (for versions 7.2 to 8.x only)
SearchSource string This property was added in case anyone wants to use Compass during the transition from 7.2 to 8.x. Indicates the search tool used for search on the platform. The default value is elastic. If you need to set Compass as the index source for searching, set this value to compass; however, note that this value will be removed shortly, and the Compass search indexing tool will no longer be supported.
ESIndexName string The name of the tenant-specific Elasticsearch index defined for the tenant, if applicable.
State string Indicates whether the tenant is active or suspended. For valid values, see State (Tenant).
PlatformApiClientID string Optional. Unique ID for the client on the API Platform.
PlatformApiContractExists boolean Optional. If set to true, the tenant has a contract on the API Platform.
ConsoleAddress string

Optional. The full URL that will be used in the browser when accessing the Community Manager developer portal user interface. The browser then redirects to the default login page.

Corresponds to the consoleAddress element in the installation Jython script.
Address string Optional. The base URL of the tenant. The hostname must be unique. There is normally no context unless the product is running in an application server. This is the default address from which the tenant is accessed. Multiple additional virtual hostnames are allowed, but the hostname provided in this element is the primary hostname. This value is used in certain notifications that provide a URL for accessing the tenant; for example, the signup confirmation email. Example: http://acmepaymentscorp:9901.
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.
Themes Theme[ ] One or more themes for the tenant. You can add, modify, or delete themes. You can have multiple themes, including clones (multiple versions, independently customizable) for default theme, hermosa theme, and simpledev theme.
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.