Tenant Types

Application

Property Type Description

Property	Type	Description
`id`	`string`	The unique identifier for this application.
`name`	`string`	The general name for the application.
`token`	`string`	The application’s token identifier.
`identifierType`	`'DOMAIN' \| 'DOMAIN_PREFIX' \| 'PARAMETER' \| 'CONTEXT_PATH'`	Defines the type of the application resolution identifier.
`identifierValue`	`string`	Determines how applications are resolved using all or part of their domains or hostnames.
`customerContextId`	`string`	The customer context id that is used to discriminate entities with TrackableBehavior#CUSTOMER_CONTEXT
`deactivated`	`boolean`	Determines whether this application is active.
`defaultLocale`	`string`	The default locales for this tenant
`allowedLocales`	`Array<string>`	List of locales that are available to be selected for this tenant.
`defaultCurrency`	`string`	The default currency for this tenant.
`allowedCurrencies`	`Array<string>`	List of currencies that are available to be selected for this tenant.
`portraitAsset?`	`Asset`	The asset information for the application’s portrait.
`logoAsset?`	`Asset`	The asset information for the application’s logo.
`attributes?`	`Record<string, unknown>`	Arbitrary attributes associated with this application.
`marketplace`	`boolean`	Whether this application is a marketplace.
`isolatedCatalogs?`	`Array<ApplicationCatalogRef>`	Individual catalogs assigned to this application.
`robots?`	`string`	tells search engine crawlers which pages or files the crawler can * or can’t request from your site.

id

string

The unique identifier for this application.

name

string

The general name for the application.

token

string

The application’s token identifier.

identifierType

'DOMAIN' | 'DOMAIN_PREFIX' | 'PARAMETER' | 'CONTEXT_PATH'

Defines the type of the application resolution identifier.

identifierValue

string

Determines how applications are resolved using all or part of their domains or hostnames.

customerContextId

string

The customer context id that is used to discriminate entities with TrackableBehavior#CUSTOMER_CONTEXT

deactivated

boolean

Determines whether this application is active.

defaultLocale

string

The default locales for this tenant

allowedLocales

Array<string>

List of locales that are available to be selected for this tenant.

defaultCurrency

string

The default currency for this tenant.

allowedCurrencies

Array<string>

List of currencies that are available to be selected for this tenant.

portraitAsset?

Asset

The asset information for the application’s portrait.

logoAsset?

Asset

The asset information for the application’s logo.

attributes?

Record<string, unknown>

Arbitrary attributes associated with this application.

marketplace

boolean

Whether this application is a marketplace.

isolatedCatalogs?

Array<ApplicationCatalogRef>

Individual catalogs assigned to this application.

robots?

string

tells search engine crawlers which pages or files the crawler can * or can’t request from your site.

ApplicationCatalogRef

Property Type Description

Property	Type	Description
`id`	`string`	The unique identifier for the catalog
`implicit`	`string`	The context id of the hidden catalog that is owned by this application.
`name`	`string`	The name of the catalog.
`mutabilityType`	`'REFERENCE' \| 'CUSTOMIZABLE'`	The modifiability of the entities inherited from the catalogs.
`visibleAsAssigned`	`boolean`	Determines whether the catalog is visible to the admin users of the related application as being assigned.
`excludeFromAdd`	`boolean`	Determines whether the admin users of the related application can select the catalog as a destination for entity add operations.
`catalogStatus`	`'ONLINE' \| 'OFFLINE' \| 'PENDING'`	The status of the catalog’s visibility for this assignment.

id

string

The unique identifier for the catalog

implicit

string

The context id of the hidden catalog that is owned by this application.

name

string

The name of the catalog.

mutabilityType

'REFERENCE' | 'CUSTOMIZABLE'

The modifiability of the entities inherited from the catalogs.

visibleAsAssigned

boolean

Determines whether the catalog is visible to the admin users of the related application as being assigned.

excludeFromAdd

boolean

Determines whether the admin users of the related application can select the catalog as a destination for entity add operations.

catalogStatus

'ONLINE' | 'OFFLINE' | 'PENDING'

The status of the catalog’s visibility for this assignment.

ApplicationRequestParams

Property Type Description

Property	Type	Description
`id?`	`string`	The application’s id.
`url?`	`string`	The application’s url.
`token?`	`string`	The application’s token.

id?

string

The application’s id.

url?

string

The application’s url.

token?

string

The application’s token.

ApplicationResolverResponse

Property Type Description

Property	Type	Description
`tenant`	`Tenant`	The resolved tenant.
`application`	`Application`	The resolved application.

tenant

Tenant

The resolved tenant.

application

Application

The resolved application.

Tenant

Property Type Description

Property	Type	Description
`id`	`string`	The tenant identifier.
`name`	`string`	The general name for the tenant.
`identifierType`	`'DOMAIN' \| 'DOMAIN_PREFIX' \| 'PARAMETER' \| 'CONTEXT_PATH'`	Defines the type of the tenant resolution identifier: Whether a domain or a domain prefix.
`identifierValue`	`string`	Determines how tenants are resolved using all or part of their domains or hostnames.
`defaultLocale`	`string`	The default locales for this tenant
`allowedLocales`	`Array<string>`	List of locales that are available to be selected for this tenant.
`defaultCurrency`	`string`	The default currency for this tenant.
`allowedCurrencies`	`Array<string>`	List of currencies that are available to be selected for this tenant.
`logoAsset?`	`Asset`	The asset information for the tenant’s logo.
`attributes?`	`Record<string, unknown>`	Arbitrary attributes associated with this tenant.

id

string

The tenant identifier.

name

string

The general name for the tenant.

identifierType

'DOMAIN' | 'DOMAIN_PREFIX' | 'PARAMETER' | 'CONTEXT_PATH'

Defines the type of the tenant resolution identifier: Whether a domain or a domain prefix.

identifierValue

string

Determines how tenants are resolved using all or part of their domains or hostnames.

defaultLocale

string

The default locales for this tenant

allowedLocales

Array<string>

List of locales that are available to be selected for this tenant.

defaultCurrency

string

The default currency for this tenant.

allowedCurrencies

Array<string>

List of currencies that are available to be selected for this tenant.

logoAsset?

Asset

The asset information for the tenant’s logo.

attributes?

Record<string, unknown>

Arbitrary attributes associated with this tenant.