SignOutAuthenticationHandler<TOptions> Class

Definition

Namespace:

Microsoft.AspNetCore.Authentication

Assembly:

Microsoft.AspNetCore.Authentication.dll

Package:

Microsoft.AspNetCore.App.Ref v9.0.2

Adds support for SignOutAsync

generic <typename TOptions>
 where TOptions : AuthenticationSchemeOptionsgcnew()public ref class SignOutAuthenticationHandler abstract : Microsoft::AspNetCore::Authentication::AuthenticationHandler<TOptions>, Microsoft::AspNetCore::Authentication::IAuthenticationSignOutHandler

public abstract class SignOutAuthenticationHandler<TOptions> : Microsoft.AspNetCore.Authentication.AuthenticationHandler<TOptions>, Microsoft.AspNetCore.Authentication.IAuthenticationSignOutHandler where TOptions : AuthenticationSchemeOptions, new()

type SignOutAuthenticationHandler<'Options (requires 'Options :> AuthenticationSchemeOptions and 'Options : (new : unit -> 'Options))> = class
    inherit AuthenticationHandler<'Options (requires 'Options :> AuthenticationSchemeOptions and 'Options : (new : unit -> 'Options))>
    interface IAuthenticationSignOutHandler
    interface IAuthenticationHandler

Public MustInherit Class SignOutAuthenticationHandler(Of TOptions)
Inherits AuthenticationHandler(Of TOptions)
Implements IAuthenticationSignOutHandler

Type Parameters

TOptions

Inheritance

Object

AuthenticationHandler<TOptions>

SignOutAuthenticationHandler<TOptions>

Derived

Microsoft.AspNetCore.Authentication.SignInAuthenticationHandler<TOptions>

Implements

IAuthenticationHandler IAuthenticationSignOutHandler

Constructors

SignOutAuthenticationHandler<TOptions>(IOptionsMonitor<TOptions>, ILoggerFactory, UrlEncoder, ISystemClock)	Obsolete. Initializes a new instance of SignOutAuthenticationHandler<TOptions>.
SignOutAuthenticationHandler<TOptions>(IOptionsMonitor<TOptions>, ILoggerFactory, UrlEncoder)	Initializes a new instance of SignOutAuthenticationHandler<TOptions>.

Properties

ClaimsIssuer	Gets the issuer that should be used when any claims are issued. (Inherited from AuthenticationHandler<TOptions>)
Clock	Obsolete. Gets the ISystemClock. (Inherited from AuthenticationHandler<TOptions>)
Context	Gets or sets the HttpContext. (Inherited from AuthenticationHandler<TOptions>)
CurrentUri	Gets the absolute current url. (Inherited from AuthenticationHandler<TOptions>)
Events	The handler calls methods on the events which give the application control at certain points where processing is occurring. If it is not provided a default instance is supplied which does nothing when the methods are called. (Inherited from AuthenticationHandler<TOptions>)
Logger	Gets the ILogger. (Inherited from AuthenticationHandler<TOptions>)
Options	Gets or sets the options associated with this authentication handler. (Inherited from AuthenticationHandler<TOptions>)
OptionsMonitor	Gets the IOptionsMonitor<TOptions> to detect changes to options. (Inherited from AuthenticationHandler<TOptions>)
OriginalPath	Gets the path as seen by the authentication middleware. (Inherited from AuthenticationHandler<TOptions>)
OriginalPathBase	Gets the path base as seen by the authentication middleware. (Inherited from AuthenticationHandler<TOptions>)
Request	Gets the HttpRequest associated with the current request. (Inherited from AuthenticationHandler<TOptions>)
Response	Gets the HttpResponse associated with the current request. (Inherited from AuthenticationHandler<TOptions>)
Scheme	Gets or sets the AuthenticationScheme associated with this authentication handler. (Inherited from AuthenticationHandler<TOptions>)
TimeProvider	Gets the current time, primarily for unit testing. (Inherited from AuthenticationHandler<TOptions>)
UrlEncoder	Gets the UrlEncoder. (Inherited from AuthenticationHandler<TOptions>)

Methods

AuthenticateAsync()	Authenticate the current request. (Inherited from AuthenticationHandler<TOptions>)
BuildRedirectUri(String)	Constructs an absolute url for the specified targetPath. (Inherited from AuthenticationHandler<TOptions>)
ChallengeAsync(AuthenticationProperties)	Challenge the current request. (Inherited from AuthenticationHandler<TOptions>)
CreateEventsAsync()	Creates a new instance of the events instance. (Inherited from AuthenticationHandler<TOptions>)
ForbidAsync(AuthenticationProperties)	Forbid the current request. (Inherited from AuthenticationHandler<TOptions>)
HandleAuthenticateAsync()	Allows derived types to handle authentication. (Inherited from AuthenticationHandler<TOptions>)
HandleAuthenticateOnceAsync()	Used to ensure HandleAuthenticateAsync is only invoked once. The subsequent calls will return the same authenticate result. (Inherited from AuthenticationHandler<TOptions>)
HandleAuthenticateOnceSafeAsync()	Used to ensure HandleAuthenticateAsync is only invoked once safely. The subsequent calls will return the same authentication result. Any exceptions will be converted into a failed authentication result containing the exception. (Inherited from AuthenticationHandler<TOptions>)
HandleChallengeAsync(AuthenticationProperties)	Override this method to deal with 401 challenge concerns, if an authentication scheme in question deals an authentication interaction as part of it's request flow. (like adding a response header, or changing the 401 result to 302 of a login page or external sign-in location.) (Inherited from AuthenticationHandler<TOptions>)
HandleForbiddenAsync(AuthenticationProperties)	Override this method to handle Forbid. (Inherited from AuthenticationHandler<TOptions>)
HandleSignOutAsync(AuthenticationProperties)	Override this method to handle SignOut.
InitializeAsync(AuthenticationScheme, HttpContext)	Initialize the handler, resolve the options and validate them. (Inherited from AuthenticationHandler<TOptions>)
InitializeEventsAsync()	Initializes the events object, called once per request by InitializeAsync(AuthenticationScheme, HttpContext). (Inherited from AuthenticationHandler<TOptions>)
InitializeHandlerAsync()	Called after options/events have been initialized for the handler to finish initializing itself. (Inherited from AuthenticationHandler<TOptions>)
ResolveTarget(String)	Resolves the scheme that this authentication operation is forwarded to. (Inherited from AuthenticationHandler<TOptions>)
SignOutAsync(AuthenticationProperties)	Signout behavior.