Class UserInteractiveAuthResponse

401 body of the user-interactive auth API.

Inheritance

object

UserInteractiveAuthResponse

Implements

IEquatable<UserInteractiveAuthResponse>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Uniform.Matrix.Protocol.Core

Assembly: Uniform.Matrix.Protocol.Core.dll

Syntax

public sealed record UserInteractiveAuthResponse : IEquatable<UserInteractiveAuthResponse>

Properties

Completed

Stages already completed in this session.

Declaration

public IReadOnlyList<string> Completed { get; init; }

Property Value

Type	Description
IReadOnlyList<string>

Errcode

Error of the previous attempt, e.g. M_FORBIDDEN for a wrong password.

Declaration

public string? Errcode { get; init; }

Property Value

Type	Description
string

Error

Human-readable error of the previous attempt.

Declaration

public string? Error { get; init; }

Property Value

Type	Description
string

Flows

Accepted combinations of stages.

Declaration

public IReadOnlyList<AuthFlow> Flows { get; init; }

Property Value

Type	Description
IReadOnlyList<AuthFlow>

Params

Parameters of each stage, by stage type; servers send an empty object when no stage needs any.

Declaration

public IReadOnlyDictionary<string, JsonObject>? Params { get; init; }

Property Value

Type	Description
IReadOnlyDictionary<string, JsonObject>

Session

Session to pass back in the next attempt.

Declaration

public string? Session { get; init; }

Property Value

Type	Description
string

Implements

IEquatable<T>