Class TenantMembership

Namespace

Stratara.Abstractions.Multitenancy

Assembly

Stratara.Abstractions.dll

One user's membership in one tenant, carrying the tenant-scoped roles the user holds there. The user↔tenant relationship is many-to-many: a user may hold any number of memberships, each with its own role set, and single-tenant applications are simply the degenerate case of one membership per user.

[ExcludeFromCodeCoverage]
public sealed record TenantMembership : IEquatable<TenantMembership>

Inheritance

object

TenantMembership

Implements

IEquatable<TenantMembership>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

FieldChangedEventExtensions.ApplyPropertyChanged<TAggregate>(TAggregate, FieldChangedEvent<TAggregate>)

EventStream.ApplyEvents(object, IReadOnlyList<IEvent>)

Remarks

Roles are tenant-scoped role names (for example a tenant-administrator role) that apply only within TenantId. They are independent of any global platform roles the identity system may manage elsewhere (such as ASP.NET Identity's role store); authorization components that consume memberships are expected to consult both levels.

A membership with Pending status represents an invitation that has not been accepted yet and confers no access.

Constructors

TenantMembership(Guid, Guid, IReadOnlyCollection<string>, MembershipStatus)

One user's membership in one tenant, carrying the tenant-scoped roles the user holds there. The user↔tenant relationship is many-to-many: a user may hold any number of memberships, each with its own role set, and single-tenant applications are simply the degenerate case of one membership per user.

public TenantMembership(Guid UserId, Guid TenantId, IReadOnlyCollection<string> Roles, MembershipStatus Status = MembershipStatus.Active)

Parameters

UserId Guid

The user who holds the membership.

TenantId Guid

The tenant the membership belongs to.

Roles IReadOnlyCollection<string>

Tenant-scoped role names the user holds within TenantId. Never null; empty when the user is a plain member without elevated tenant roles.

Status MembershipStatus

Lifecycle state of the membership; defaults to Active.

Remarks

Roles are tenant-scoped role names (for example a tenant-administrator role) that apply only within TenantId. They are independent of any global platform roles the identity system may manage elsewhere (such as ASP.NET Identity's role store); authorization components that consume memberships are expected to consult both levels.

A membership with Pending status represents an invitation that has not been accepted yet and confers no access.

Properties

Roles

Tenant-scoped role names the user holds within TenantId. Never null; empty when the user is a plain member without elevated tenant roles.

public IReadOnlyCollection<string> Roles { get; init; }

Property Value

IReadOnlyCollection<string>

Status

Lifecycle state of the membership; defaults to Active.

public MembershipStatus Status { get; init; }

Property Value

MembershipStatus

TenantId

The tenant the membership belongs to.

public Guid TenantId { get; init; }

Property Value

Guid

UserId

The user who holds the membership.

public Guid UserId { get; init; }

Property Value

Guid