Class UpstreamSignOutResult

Namespace

Fdyay.IdentityServer.Hosting

Assembly

Fdyay.IdentityServer.AspNetCore.dll

Hands the browser to an upstream provider so it can end its own session, and asks for it back.

public sealed class UpstreamSignOutResult : IEndpointResult

Inheritance

object

UpstreamSignOutResult

Implements

IEndpointResult

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

The counterpart of a Razor page's SignOut(properties, scheme), for the protocol endpoints, which return a result rather than having one returned for them. The handler owns what actually happens: an OpenID Connect provider redirects to its end-session endpoint carrying the returnUrl it was given as the address to come back to, and a SAML one sends a LogoutRequest. Neither is this server's business beyond naming the scheme.

Constructors

UpstreamSignOutResult(string, string)

Holds the scheme to sign out of and where to come back to.

public UpstreamSignOutResult(string scheme, string returnUrl)

Parameters

scheme string

The upstream provider's authentication scheme.

returnUrl string

The URL the provider sends the browser back to once its session has ended.

Exceptions

ArgumentException

scheme or returnUrl is null or empty.

Methods

ExecuteAsync(HttpContext)

Signs out of the upstream scheme, which hands the browser to the provider with returnUrl as where to return.

public Task ExecuteAsync(HttpContext context)

Parameters

context HttpContext

The request whose response is written.

Returns

Task

A task that completes when the handler has written its response.