Skip to main content

EndSessionRequest Class

Abblix.Oidc.Server

Abblix.Oidc.Server.Model

EndSessionRequest Class

Parameters of an RP-initiated logout request to the OpenID Provider's end_session_endpoint, as defined in OpenID Connect RP-Initiated Logout 1.0.

public record EndSessionRequest : System.IEquatable<Abblix.Oidc.Server.Model.EndSessionRequest>

Inheritance System.Object → EndSessionRequest

Implements System.IEquatable<EndSessionRequest>

Properties

EndSessionRequest.ClientId Property

The client_id of the relying party initiating the logout, allowing the OP to validate PostLogoutRedirectUri against the URIs registered for that client.

public string? ClientId { get; set; }

Property Value

System.String

EndSessionRequest.Confirmed Property

Carries the End-User's answer to the logout confirmation prompt that the OP is required to display per OIDC RP-Initiated Logout 1.0 §2 ("the OP SHOULD ask the End-User whether to log out ... MUST ask ... if an id_token_hint was not provided"). When true, the user has explicitly approved logout in the interactive UI; when null or false, the request is treated as not-yet-confirmed and the OP renders the confirmation screen. Encoded via the Confirmed form field rather than a wire parameter defined by the specification.

public System.Nullable<bool> Confirmed { get; set; }

Property Value

System.Nullable<System.Boolean>

EndSessionRequest.IdTokenHint Property

The id_token_hint: a previously issued ID Token whose subject identifies the end-user whose session should be terminated. Recommended by RP-Initiated Logout to authenticate the logout request and to scope which session is logged out.

public string? IdTokenHint { get; set; }

Property Value

System.String

EndSessionRequest.LogoutHint Property

The logout_hint: an opaque hint about the end-user's login identifier (such as username or email) the OpenID Provider may use to identify the session to terminate when an ID Token hint is unavailable.

public string? LogoutHint { get; set; }

Property Value

System.String

EndSessionRequest.PostLogoutRedirectUri Property

The post_logout_redirect_uri: an absolute URI, pre-registered with the OP, to which the user agent is redirected once logout completes.

public System.Uri? PostLogoutRedirectUri { get; set; }

Property Value

System.Uri

EndSessionRequest.State Property

The opaque state value returned unchanged when the user agent is sent back to PostLogoutRedirectUri, used by the relying party to correlate request and callback.

public string? State { get; set; }

Property Value

System.String

EndSessionRequest.UiLocales Property

The ui_locales preference list of BCP 47 language tags hinting how the logout confirmation page should be localized.

public System.Collections.Generic.IEnumerable<System.Globalization.CultureInfo>? UiLocales { get; set; }

Property Value

System.Collections.Generic.IEnumerable<System.Globalization.CultureInfo>