Skip to main content

SuccessfullyAuthenticated Class

Abblix.Oidc.Server

Abblix.Oidc.Server.Endpoints.Authorization.Interfaces

SuccessfullyAuthenticated Class

Represents a successful authentication response, encapsulating details about the outcome of an authentication request, including any tokens issued as a result.

public record SuccessfullyAuthenticated : Abblix.Oidc.Server.Endpoints.Authorization.Interfaces.ClientDeliveredResponse, System.IEquatable<Abblix.Oidc.Server.Endpoints.Authorization.Interfaces.SuccessfullyAuthenticated>

Inheritance System.ObjectAuthorizationResponseClientDeliveredResponse → SuccessfullyAuthenticated

Implements System.IEquatable<SuccessfullyAuthenticated>

Constructors

SuccessfullyAuthenticated(AuthorizationRequest, string, string, ICollection<string>) Constructor

Represents a successful authentication response, encapsulating details about the outcome of an authentication request, including any tokens issued as a result.

public SuccessfullyAuthenticated(Abblix.Oidc.Server.Model.AuthorizationRequest Model, string ResponseMode, string? SessionId, System.Collections.Generic.ICollection<string> AffectedClientIds);

Parameters

Model AuthorizationRequest

The original authorization request that led to this successful authentication.

ResponseMode System.String

Specifies how the result of the authentication should be returned to the client.

SessionId System.String

An optional session identifier that may be used for session management.

AffectedClientIds System.Collections.Generic.ICollection<System.String>

Identifiers of the clients that are affected by or related to this authentication process.

Properties

SuccessfullyAuthenticated.AccessToken Property

The access token issued as part of the authentication response, encoded in a format suitable for transmission. Access tokens are credentials used to access protected resources.

public Abblix.Oidc.Server.Features.Tokens.EncodedJsonWebToken? AccessToken { get; set; }

Property Value

EncodedJsonWebToken

SuccessfullyAuthenticated.AffectedClientIds Property

Identifiers of the clients that are affected by or related to this authentication process.

public System.Collections.Generic.ICollection<string> AffectedClientIds { get; init; }

Property Value

System.Collections.Generic.ICollection<System.String>

SuccessfullyAuthenticated.Code Property

An authorization code that can be exchanged for tokens. This code is issued only if the authentication request was successful and the response type requested an authorization code.

public string? Code { get; set; }

Property Value

System.String

SuccessfullyAuthenticated.GrantedScopes Property

The scope actually granted by the user-consent decision — the same set the issued access/ID token carries. Threaded by the authorization request processor so the response encoder advertises it on the front-channel scope parameter. May be a subset of the requested Scope when the host consent provider narrows the grant (RFC 6749 §3.3).

public string[] GrantedScopes { get; init; }

Property Value

System.String[]

SuccessfullyAuthenticated.IdToken Property

The ID token issued as part of the authentication response, providing identity information about the user. Encoded in a format suitable for transmission.

public Abblix.Oidc.Server.Features.Tokens.EncodedJsonWebToken? IdToken { get; set; }

Property Value

EncodedJsonWebToken

SuccessfullyAuthenticated.Scope Property

The granted scope as a space-delimited string, populated by the response encoder for implicit/hybrid flows only (where the response itself carries tokens). null for the code flow.

public string? Scope { get; set; }

Property Value

System.String

SuccessfullyAuthenticated.SessionId Property

An optional session identifier that may be used for session management.

public string? SessionId { get; init; }

Property Value

System.String

SuccessfullyAuthenticated.SessionState Property

An optional state parameter reflecting the session state. This can be used to represent the state of the user's session at the authorization server and may be used for managing session continuity and logout.

public string? SessionState { get; set; }

Property Value

System.String

SuccessfullyAuthenticated.TokenType Property

The type of token issued, typically "Bearer", indicating how the issued token may be used. This property is populated if an access token is issued as part of the authentication response.

public string? TokenType { get; set; }

Property Value

System.String