TenantryApplicationBuilderExtensions class

Namespace: Microsoft.AspNetCore.Builder · Package: Tenantry.AspNetCore · API reference

Adds Tenantry's tenant resolution to the request pipeline.

public static class TenantryApplicationBuilderExtensions

MethodsCopy Anchor Link

UseTenantry(IApplicationBuilder)Copy Anchor Link

Adds the tenant resolution middleware to the pipeline. Must be called after authentication middleware (app.UseAuthentication()) if using claim-based resolution, and before any middleware that requires a resolved tenant (e.g. authorisation, controllers). When using RequireTenant() or AllowMissingTenant() endpoint metadata, ensure routing has executed before this middleware. WebApplication handles this automatically for minimal APIs and controllers.

public static IApplicationBuilder UseTenantry(this IApplicationBuilder app)

Parameters:

• app IApplicationBuilder: The application's request pipeline.

Returns: IApplicationBuilder: The same app for chaining.

Exceptions:

• InvalidOperationException: Tenantry is not registered with a way to resolve requests (a ResolveFrom… or UseResolver method in AddTenantry), or no tenant store is registered.