Tenantry CoreAPI reference

ITenantDescriptor<TKey> interface

Namespace: Tenantry.Core · Package: Tenantry.Core · API reference

Represents a resolved tenant.

public interface ITenantDescriptor<out TKey> where TKey : IEquatable<out TKey>, IParsable<out TKey>

Type parameters

TKey: The type used for tenant identifiers (e.g. Guid, string, int). Must implement IEquatable<T> so EF Core can translate equality checks to SQL, and IParsable<TSelf> so middleware can parse the raw string value from HTTP headers/routes.

Human-readable display name for the tenant.

string Name { get; }

Value: string

Unique tenant identifier used for data isolation.

TKey TenantId { get; }

Value: TKey

ITenantContext<TKey> interface

Provides read-only access to the currently resolved tenant for the active request scope.

ITenantScope<TKey> interface

Represents a scoped interface for managing tenant-specific context within the application.