Micronaut Multitenancy Configuration Reference

Every documented configuration property of Micronaut Multitenancy, with types, descriptions, and defaults.

Micronaut Multitenancy documentation

28 properties across 1 section

Micronaut Multitenancy Config Properties

Configuration properties for TenantResolverFilterConfigurationProperties

Property	Type	Description
`micronaut.multitenancy.filter.enabled`	boolean	Whether TenantResolverFilter should be enabled. Default value (true).
`micronaut.multitenancy.filter.regex-pattern`	java.lang.String	Tenant Resolver filter processes only request paths matching this regular expression. Default Value: "^.*$"

Configuration properties for TenantPropagationConfigurationProperties

Property	Type	Description
`micronaut.multitenancy.propagation.service-id-regex`	java.lang.String	Regular expression to match service ID.
`micronaut.multitenancy.propagation.uri-regex`	java.lang.String	Regular expression to match URI.
`micronaut.multitenancy.propagation.enabled`	boolean	Whether TenantPropagationHttpClientFilter should be enabled. Default value (false).
`micronaut.multitenancy.propagation.path`	java.lang.String	Configures TenantPropagationHttpClientFilter path. Default value "/**"

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").

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).

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").

Configuration properties for PrincipalTenantResolverConfigurationProperties

Property	Type	Description
`micronaut.multitenancy.tenantresolver.principal.enabled`	boolean	Enables PrincipalTenantResolver . The default enable is false.

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")

Configuration properties for SubdomainTenantResolverConfigurationProperties

Property	Type	Description
`micronaut.multitenancy.tenantresolver.subdomain.enabled`	boolean	Enables SubdomainTenantResolver . Default value (false).

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).

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	Cookie Name. Default value ("tenantId").
`micronaut.multitenancy.tenantwriter.cookie.cookie-domain`	java.lang.String	Sets the domain name of this Cookie. Default value ("tenantId").
`micronaut.multitenancy.tenantwriter.cookie.cookie-path`	java.lang.String	Sets the path of the cookie. Default value ("/".
`micronaut.multitenancy.tenantwriter.cookie.cookie-http-only`	boolean	Whether the Cookie can only be accessed via HTTP. Default value (true.
`micronaut.multitenancy.tenantwriter.cookie.cookie-secure`	boolean	Sets whether the cookie is secured. Defaults to the secure status of the request.
`micronaut.multitenancy.tenantwriter.cookie.cookie-max-age`	java.time.temporal.TemporalAmount	Sets the maximum age of the cookie.
`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>

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	Http Header name. Default value ("tenantId").