Configuration Reference

Version:5.4.0

Micronaut Multitenancy Config Properties

🔗
Table 1. Configuration Properties for FixedTenantResolverConfigurationProperties
Property Type Description

micronaut.multitenancy.tenantresolver.fixed.tenant-id

java.lang.String

The fixed tenant ID. Default value to ("DEFAULT").

micronaut.multitenancy.tenantresolver.fixed.enabled

boolean

Enables FixedTenantResolver. Default value (false).

🔗
Table 2. Configuration Properties for SessionTenantResolverConfigurationProperties
Property Type Description

micronaut.multitenancy.tenantresolver.session.enabled

boolean

Enables SessionTenantResolver. The default value (false).

micronaut.multitenancy.tenantresolver.session.attribute

java.lang.String

Session Attribute name. Default value ("tenantId")

🔗
Table 3. Configuration Properties for PrincipalTenantResolverConfigurationProperties
Property Type Description

micronaut.multitenancy.tenantresolver.principal.enabled

boolean

Enables PrincipalTenantResolver. The default enable is false.

🔗
Table 4. Configuration Properties for HttpHeaderTenantWriterConfigurationProperties
Property Type Description

micronaut.multitenancy.tenantwriter.httpheader.enabled

boolean

Enables HttpHeaderTenantWriter. Default value (false).

micronaut.multitenancy.tenantwriter.httpheader.header-name

java.lang.String

🔗
Table 5. Configuration Properties for SystemPropertyTenantResolverConfigurationProperties
Property Type Description

micronaut.multitenancy.tenantresolver.systemproperty.property-name

java.lang.String

System property name. Default value ("tenantId").

micronaut.multitenancy.tenantresolver.systemproperty.enabled

boolean

Enable SystemPropertyTenantResolver. Default value (false).

🔗
Table 6. Configuration Properties for TenantPropagationConfigurationProperties
Property Type Description

micronaut.multitenancy.propagation.service-id-regex

java.lang.String

micronaut.multitenancy.propagation.uri-regex

java.lang.String

micronaut.multitenancy.propagation.enabled

boolean

Whether TenantPropagationHttpClientFilter should be enabled. Default value (false).

micronaut.multitenancy.propagation.path

java.lang.String

🔗
Table 7. Configuration Properties for SubdomainTenantResolverConfigurationProperties
Property Type Description

micronaut.multitenancy.tenantresolver.subdomain.enabled

boolean

Enables SubdomainTenantResolver. Default value (false).

🔗
Table 8. Configuration Properties for CookieTenantWriterConfigurationProperties
Property Type Description

micronaut.multitenancy.tenantwriter.cookie.enabled

boolean

Enables CookieTenantWriter. Default value (false).

micronaut.multitenancy.tenantwriter.cookie.cookiename

java.lang.String

micronaut.multitenancy.tenantwriter.cookie.cookie-domain

java.lang.String

micronaut.multitenancy.tenantwriter.cookie.cookie-path

java.lang.String

micronaut.multitenancy.tenantwriter.cookie.cookie-http-only

boolean

micronaut.multitenancy.tenantwriter.cookie.cookie-secure

boolean

micronaut.multitenancy.tenantwriter.cookie.cookie-max-age

java.time.temporal.TemporalAmount

micronaut.multitenancy.tenantwriter.cookie.cookie-same-site

SameSite

Determines if this this Cookie can be sent along cross-site requests. For more information, please look <a href="https://tools.ietf.org/html/draft-ietf-httpbis-rfc6265bis-05">here</a>

🔗
Table 9. Configuration Properties for HttpHeaderTenantResolverConfigurationProperties
Property Type Description

micronaut.multitenancy.tenantresolver.httpheader.enabled

boolean

Enables HttpHeaderTenantResolver. Default value (false).

micronaut.multitenancy.tenantresolver.httpheader.header-name

java.lang.String

Http Header name which should be used to resolve the tenant id from. Default value ("tenantId").

🔗
Table 10. Configuration Properties for CookieTenantResolverConfigurationProperties
Property Type Description

micronaut.multitenancy.tenantresolver.cookie.enabled

boolean

Whether to enable CookieTenantResolver. Default value (false).

micronaut.multitenancy.tenantresolver.cookie.cookiename

java.lang.String

Cookie name which should be used to resolve the tenant id from. Default value ("tenantId").