Class TenancyOptions

Namespace
Cratis.Arc.Tenancy
Assembly
Cratis.Arc.Core.dll

Represents the options for tenancy.

public class TenancyOptions
Inheritance
TenancyOptions
Inherited Members
Extension Methods

Constructors

TenancyOptions()

public TenancyOptions()

Properties

BaseDomain

Gets or sets the base domain the application is served from when using Subdomain.

public string BaseDomain { get; set; }

Property Value

string

Remarks

A request host carries a tenant only when it is exactly one label in front of this value - acme.myapp.com for the base domain myapp.com. Every other host, including the base domain itself, falls back to HttpHeader. It is required for Subdomain and must be the registrable domain the application is served from; anything the resolver could not match a tenant host against

  • an empty value, a single label, an address literal - throws BaseDomainIsNotADomainName rather than leaving every request to resolve its tenant from the client-supplied header.

ClaimType

Gets or sets the claim type to use for the tenant ID when using Claim.

public string ClaimType { get; set; }

Property Value

string

DevelopmentTenantId

Gets or sets the fixed tenant ID to use when using Development.

public string DevelopmentTenantId { get; set; }

Property Value

string

Remarks

This is FixedTenantId under its original name - both names read and write the same value, so configuration and code may use either. When a configuration source supplies both keys, the last one the binder visits wins; supply only one.

FixedTenantId

Gets or sets the tenant ID every request resolves to when using Fixed or Development.

public string FixedTenantId { get; set; }

Property Value

string

HttpHeader

Gets or sets the HTTP header to use for the tenant ID when using Header.

public string HttpHeader { get; set; }

Property Value

string

QueryParameter

Gets or sets the query string parameter to use for the tenant ID when using Query.

public string QueryParameter { get; set; }

Property Value

string

ResolverType

Gets or sets the type of tenant resolver to use.

public TenantResolverType ResolverType { get; set; }

Property Value

TenantResolverType