Class TenantMembershipEvaluationResult
Namespace: Cephalon.MultiTenancy.Governance.Services
Assembly: Cephalon.MultiTenancy.Governance.dll
Describes the result of one tenant-membership evaluation.
public sealed class TenantMembershipEvaluationResultInheritance
Section titled “Inheritance”object ← TenantMembershipEvaluationResult
Inherited Members
Section titled “Inherited Members”object.Equals(object?), object.Equals(object?, object?), object.GetHashCode(), object.GetType(), object.ReferenceEquals(object?, object?), object.ToString()
Constructors
Section titled “Constructors”TenantMembershipEvaluationResult(string, string, string, bool, DateTimeOffset, IReadOnlyList<string>?, IReadOnlyList<string>?, IReadOnlyList<string>?, IReadOnlyList<TenantMembershipDescriptor>?, string?, IReadOnlyDictionary<string, string>?, string?)
Section titled “ TenantMembershipEvaluationResult(string, string, string, bool, DateTimeOffset, IReadOnlyList<string>?, IReadOnlyList<string>?, IReadOnlyList<string>?, IReadOnlyList<TenantMembershipDescriptor>?, string?, IReadOnlyDictionary<string, string>?, string?)”Creates a tenant-membership evaluation result.
public TenantMembershipEvaluationResult(string tenantId, string principalId, string outcome, bool allowed, DateTimeOffset evaluatedAtUtc, IReadOnlyList<string>? requiredRoles = null, IReadOnlyList<string>? matchedRoles = null, IReadOnlyList<string>? missingRoles = null, IReadOnlyList<TenantMembershipDescriptor>? matchedMemberships = null, string? reason = null, IReadOnlyDictionary<string, string>? metadata = null, string? principalKind = null)Parameters
Section titled “Parameters”tenantId string
The tenant identifier that was evaluated.
principalId string
The principal identifier that was evaluated.
outcome string
The stable evaluation outcome.
allowed bool
A value indicating whether evaluation granted access.
evaluatedAtUtc DateTimeOffset
The UTC timestamp when evaluation executed.
requiredRoles IReadOnlyList<string>?
The tenant-local roles required by the request.
matchedRoles IReadOnlyList<string>?
The tenant-local roles found on active memberships.
missingRoles IReadOnlyList<string>?
The required roles that were not found.
matchedMemberships IReadOnlyList<TenantMembershipDescriptor>?
The matching memberships considered by evaluation.
reason string?
The optional operator-facing evaluation reason.
metadata IReadOnlyDictionary<string, string>?
Optional result metadata.
principalKind string?
The principal kind that was evaluated. The default is user.
Properties
Section titled “Properties”Allowed
Section titled “ Allowed”Gets a value indicating whether evaluation granted access.
public bool Allowed { get; }Property Value
Section titled “Property Value”EvaluatedAtUtc
Section titled “ EvaluatedAtUtc”Gets the UTC timestamp when evaluation executed.
public DateTimeOffset EvaluatedAtUtc { get; }Property Value
Section titled “Property Value”MatchedMemberships
Section titled “ MatchedMemberships”Gets the matching memberships considered by evaluation.
public IReadOnlyList<TenantMembershipDescriptor> MatchedMemberships { get; }Property Value
Section titled “Property Value”IReadOnlyList<TenantMembershipDescriptor>
MatchedRoles
Section titled “ MatchedRoles”Gets the tenant-local roles found on active memberships.
public IReadOnlyList<string> MatchedRoles { get; }Property Value
Section titled “Property Value”Metadata
Section titled “ Metadata”Gets optional result metadata.
public IReadOnlyDictionary<string, string> Metadata { get; }Property Value
Section titled “Property Value”IReadOnlyDictionary<string, string>
MissingRoles
Section titled “ MissingRoles”Gets the required roles that were not found.
public IReadOnlyList<string> MissingRoles { get; }Property Value
Section titled “Property Value”Outcome
Section titled “ Outcome”Gets the stable evaluation outcome.
public string Outcome { get; }Property Value
Section titled “Property Value”PrincipalId
Section titled “ PrincipalId”Gets the principal identifier that was evaluated.
public string PrincipalId { get; }Property Value
Section titled “Property Value”PrincipalKind
Section titled “ PrincipalKind”Gets the principal kind that was evaluated.
public string PrincipalKind { get; }Property Value
Section titled “Property Value”Reason
Section titled “ Reason”Gets the optional operator-facing evaluation reason.
public string? Reason { get; }Property Value
Section titled “Property Value”RequiredRoles
Section titled “ RequiredRoles”Gets the tenant-local roles required by the request.
public IReadOnlyList<string> RequiredRoles { get; }Property Value
Section titled “Property Value”TenantId
Section titled “ TenantId”Gets the tenant identifier that was evaluated.
public string TenantId { get; }