Class AuthenticationResult

Namespace

Cratis.Arc.Authentication

Assembly

Cratis.Arc.Core.dll

Represents the result of an authentication attempt.

public record AuthenticationResult : IEquatable<AuthenticationResult>

Inheritance

object

AuthenticationResult

Implements

IEquatable<AuthenticationResult>

Inherited Members

object.GetType()

object.MemberwiseClone()

object.Equals(object, object)

object.ReferenceEquals(object, object)

Extension Methods

MethodCalls.CallGenericMethod<TOut, T>(T, Expression<Func<T, Func<TOut>>>, params Type[])

MethodCalls.CallGenericMethod<TOut, T, T1>(T, Expression<Func<T, Func<T1, TOut>>>, T1, params Type[])

MethodCalls.CallGenericMethod<TOut, T, T1, T2>(T, Expression<Func<T, Func<T1, T2, TOut>>>, T1, T2, params Type[])

MethodCalls.CallGenericMethod<TOut, T, T1, T2, T3>(T, Expression<Func<T, Func<T1, T2, T3, TOut>>>, T1, T2, T3, params Type[])

ConverterExtensions.ConvertTo(object, Type)

ConceptExtensions.GetConceptValue(object)

ConceptExtensions.IsConcept(object)

JsonValueExtensions.ToJsonValue(object?)

ObservableExtensions.InvokeAndWrapWithSubject<TResult>(object, Func<CancellationToken, IObservable<TResult>>)

ObservableExtensions.InvokeAndWrapWithTransformSubject<TResult, TSource>(object, Func<CancellationToken, IObservable<TSource>>, Func<TSource, TResult>)

Constructors

AuthenticationResult(AuthenticationResult)

protected AuthenticationResult(AuthenticationResult original)

Parameters

original AuthenticationResult

AuthenticationResult(ClaimsPrincipal?, AuthenticationFailure?)

Represents the result of an authentication attempt.

public AuthenticationResult(ClaimsPrincipal? Principal = null, AuthenticationFailure? Failure = null)

Parameters

Principal ClaimsPrincipal

The authenticated principal.

Failure AuthenticationFailure

The authentication failure.

Fields

Anonymous

Gets an anonymous authentication result.

public static readonly AuthenticationResult Anonymous

Field Value

AuthenticationResult

Properties

EqualityContract

protected virtual Type EqualityContract { get; }

Property Value

Type

Failure

The authentication failure.

public AuthenticationFailure? Failure { get; init; }

Property Value

AuthenticationFailure

IsAuthenticated

Gets the authenticated principal.

public bool IsAuthenticated { get; }

Property Value

bool

Principal

The authenticated principal.

public ClaimsPrincipal? Principal { get; init; }

Property Value

ClaimsPrincipal

Methods

Deconstruct(out ClaimsPrincipal?, out AuthenticationFailure?)

public void Deconstruct(out ClaimsPrincipal? Principal, out AuthenticationFailure? Failure)

Parameters

Principal ClaimsPrincipal

Failure AuthenticationFailure

Equals(AuthenticationResult?)

public virtual bool Equals(AuthenticationResult? other)

Parameters

other AuthenticationResult

Returns

bool

Equals(object?)

public override bool Equals(object? obj)

Parameters

obj object

Returns

bool

Failed(AuthenticationFailureReason)

Creates a failed authentication result.

public static AuthenticationResult Failed(AuthenticationFailureReason reason)

Parameters

reason AuthenticationFailureReason

The reason for the authentication failure.

Returns

AuthenticationResult

The failed AuthenticationResult.

GetHashCode()

public override int GetHashCode()

Returns

int

PrintMembers(StringBuilder)

protected virtual bool PrintMembers(StringBuilder builder)

Parameters

builder StringBuilder

Returns

bool

Succeeded(ClaimsPrincipal)

Creates a successful authentication result.

public static AuthenticationResult Succeeded(ClaimsPrincipal principal)

Parameters

principal ClaimsPrincipal

The authenticated principal.

Returns

AuthenticationResult

The successful AuthenticationResult.

ToString()

public override string ToString()

Returns

string

Operators

operator ==(AuthenticationResult?, AuthenticationResult?)

public static bool operator ==(AuthenticationResult? left, AuthenticationResult? right)

Parameters

left AuthenticationResult

right AuthenticationResult

Returns

bool

operator !=(AuthenticationResult?, AuthenticationResult?)

public static bool operator !=(AuthenticationResult? left, AuthenticationResult? right)

Parameters

left AuthenticationResult

right AuthenticationResult

Returns

bool