Class LogoutRequest

Namespace

Fdyay.IdentityServer.Models

Assembly

Fdyay.IdentityServer.AspNetCore.dll

Details of a pending signout request, for the logout UI.

public sealed class LogoutRequest

Inheritance

object

LogoutRequest

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Properties

ClientId

The client that initiated the signout, if it is known.

public string? ClientId { get; init; }

Property Value

string

ClientIds

The clients the session authenticated, captured before it ended. Duende's.

public IReadOnlyCollection<string> ClientIds { get; init; }

Property Value

IReadOnlyCollection<string>

ClientName

Display name of the client that initiated the signout, if it is known.

public string? ClientName { get; init; }

Property Value

string

FrontChannelLogoutUrls

The clients' front-channel logout URLs, to be loaded in hidden iframes by the signed-out page.

public IReadOnlyCollection<string> FrontChannelLogoutUrls { get; init; }

Property Value

IReadOnlyCollection<string>

Remarks

Each is a client's registered URI with iss, and sid where the client asked for it, already appended. Loading them in the user's browser is what lets each client clear its own cookie: the browser is the only party that holds a session with all of them.

The alternative shape is a single URL pointing at an endpoint that renders the iframes itself. The difference is where they are assembled, not what the browser ends up loading.

Parameters

The parameters of the end_session request that started the sign-out, less the ones this server has already acted on: id_token_hint, post_logout_redirect_uri, state and ui_locales. Empty for a sign-out that did not start there. Duende's.

public IReadOnlyDictionary<string, string> Parameters { get; init; }

Property Value

IReadOnlyDictionary<string, string>

Remarks

For a host's logout page to read a parameter of its own that a relying party sent — a reason, a locale hint it understands. Duende's is a NameValueCollection; this server reads end_session parameters as one value each, and hands them on in the shape it read them.

PostLogoutRedirectUri

The post-signout redirect URI requested by the client, if it is known.

public string? PostLogoutRedirectUri { get; init; }

Property Value

string

SamlSessions

The SAML service providers the session issued assertions to, captured before it ended. Duende's.

public IReadOnlyCollection<SamlSpSessionData> SamlSessions { get; init; }

Property Value

IReadOnlyCollection<SamlSpSessionData>

SessionId

The session being signed out, if the context is known.

public string? SessionId { get; init; }

Property Value

string

SubjectId

The subject being signed out, if the context is known.

public string? SubjectId { get; init; }

Property Value

string

UiLocales

The end_session request's ui_locales, as the validator kept it, when it sent one. Duende's.

public string? UiLocales { get; init; }

Property Value

string

Remarks

New in 0.156.0. A local logout page is also told it through IUiLocalesService.