AuthenticationHandler<TOptions> Class

Definition

Namespace:

Microsoft.AspNetCore.Authentication

Assembly:

Microsoft.AspNetCore.Authentication.dll

Package:

Microsoft.AspNetCore.App.Ref v9.0.0

An opinionated abstraction for implementing IAuthenticationHandler.

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

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

Public MustInherit Class AuthenticationHandler(Of TOptions)
Implements IAuthenticationHandler

Type Parameters

TOptions

The type for the options used to configure the authentication handler.

Inheritance

Object

AuthenticationHandler<TOptions>

Derived

Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerHandler

Microsoft.AspNetCore.Authentication.Negotiate.NegotiateHandler

Microsoft.AspNetCore.Authentication.RemoteAuthenticationHandler<TOptions>

Microsoft.AspNetCore.Authentication.SignOutAuthenticationHandler<TOptions>

Implements

IAuthenticationHandler

Constructors

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

Properties

ClaimsIssuer	Gets the issuer that should be used when any claims are issued.
Clock	Obsolete. Gets the ISystemClock.
Context	Gets or sets the HttpContext.
CurrentUri	Gets the absolute current url.
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.
Logger	Gets the ILogger.
Options	Gets or sets the options associated with this authentication handler.
OptionsMonitor	Gets the IOptionsMonitor<TOptions> to detect changes to options.
OriginalPath	Gets the path as seen by the authentication middleware.
OriginalPathBase	Gets the path base as seen by the authentication middleware.
Request	Gets the HttpRequest associated with the current request.
Response	Gets the HttpResponse associated with the current request.
Scheme	Gets or sets the AuthenticationScheme associated with this authentication handler.
TimeProvider	Gets the current time, primarily for unit testing.
UrlEncoder	Gets the UrlEncoder.

Methods

AuthenticateAsync()	Authenticate the current request.
BuildRedirectUri(String)	Constructs an absolute url for the specified targetPath.
ChallengeAsync(AuthenticationProperties)	Challenge the current request.
CreateEventsAsync()	Creates a new instance of the events instance.
ForbidAsync(AuthenticationProperties)	Forbid the current request.
HandleAuthenticateAsync()	Allows derived types to handle authentication.
HandleAuthenticateOnceAsync()	Used to ensure HandleAuthenticateAsync is only invoked once. The subsequent calls will return the same authenticate result.
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.
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.)
HandleForbiddenAsync(AuthenticationProperties)	Override this method to handle Forbid.
InitializeAsync(AuthenticationScheme, HttpContext)	Initialize the handler, resolve the options and validate them.
InitializeEventsAsync()	Initializes the events object, called once per request by InitializeAsync(AuthenticationScheme, HttpContext).
InitializeHandlerAsync()	Called after options/events have been initialized for the handler to finish initializing itself.
ResolveTarget(String)	Resolves the scheme that this authentication operation is forwarded to.