Interface: TenantConfig
Defined in: types.ts:15
Indexable
[
packageKey:string]:unknown
Namespaced configuration contributed by an installed package, via the server-side
PackageServiceProvider::addClientConfig() hook (e.g. worldpay). A key is absent
whenever that package is not installed or not fully configured for the tenant, so
always treat a missing key as "this integration is unavailable" rather than
assuming a default. Never contains credentials — this object is serialized into a
script-tag attribute on a public page.
Properties
| Property | Type | Description | Defined in |
|---|---|---|---|
assets? | TenantAssets | URLs of the bundles the SDK loads on demand. Absent when the tenant has no compiled builds. | types.ts:31 |
canonicalUrl? | string | Canonical URL for the tenant (e.g. 'https://example.org'). When the tenant has a custom domain configured, this is the custom domain URL; otherwise it falls back to the platform subdomain. Used as the base URL for third-party login popups and other flows that should originate from the tenant's own domain. | types.ts:25 |
captcha? | CaptchaTenantConfig | Captcha provider and its public configuration. Present only when a provider is selected and fully configured. | types.ts:29 |
cookieDomain? | string | Cookie domain to scope SDK cookies (e.g. '.example.org'). When set, cookies are readable across all subdomains. | types.ts:19 |
heartbeat? | HeartbeatConfig | Heartbeat/beacon configuration. Present only when the SdkHeartbeat feature is active for the tenant. | types.ts:27 |
loginProviders | string[] | Slugs of OAuth providers enabled for this tenant (e.g. ['google', 'apple']). | types.ts:17 |