RemoteAuthenticationHandler<TOptions> Class

Definition

generic <typename TOptions>
 where TOptions : RemoteAuthenticationOptionsgcnew()public ref class RemoteAuthenticationHandler abstract : Microsoft::AspNetCore::Authentication::AuthenticationHandler<TOptions>, Microsoft::AspNetCore::Authentication::IAuthenticationRequestHandler
public abstract class RemoteAuthenticationHandler<TOptions> : Microsoft.AspNetCore.Authentication.AuthenticationHandler<TOptions>, Microsoft.AspNetCore.Authentication.IAuthenticationRequestHandler where TOptions : RemoteAuthenticationOptionsnew()
type RemoteAuthenticationHandler<'Options (requires 'Options :> RemoteAuthenticationOptions and 'Options : (new : unit -> 'Options))> = class
    inherit AuthenticationHandler<'Options (requires 'Options :> RemoteAuthenticationOptions and 'Options : (new : unit -> 'Options))>
    interface IAuthenticationHandler
    interface IAuthenticationRequestHandler
Public MustInherit Class RemoteAuthenticationHandler(Of TOptions)
Inherits AuthenticationHandler(Of TOptions)
Implements IAuthenticationRequestHandler

Type Parameters

TOptions
Inheritance
RemoteAuthenticationHandler<TOptions>
Derived
Implements

Constructors

RemoteAuthenticationHandler<TOptions>()
RemoteAuthenticationHandler<TOptions>(IOptionsMonitor<TOptions>, ILoggerFactory, UrlEncoder, ISystemClock)

Properties

ChallengeCalled (Inherited from AuthenticationHandler<TOptions>)
ClaimsIssuer (Inherited from AuthenticationHandler<TOptions>)
Clock (Inherited from AuthenticationHandler<TOptions>)
Context (Inherited from AuthenticationHandler<TOptions>)
CurrentUri (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.

InitializeResult (Inherited from AuthenticationHandler<TOptions>)
Logger (Inherited from AuthenticationHandler<TOptions>)
Options (Inherited from AuthenticationHandler<TOptions>)
OptionsMonitor (Inherited from AuthenticationHandler<TOptions>)
OriginalPath (Inherited from AuthenticationHandler<TOptions>)
OriginalPathBase (Inherited from AuthenticationHandler<TOptions>)
PriorHandler (Inherited from AuthenticationHandler<TOptions>)
Request (Inherited from AuthenticationHandler<TOptions>)
Response (Inherited from AuthenticationHandler<TOptions>)
Scheme (Inherited from AuthenticationHandler<TOptions>)
SignInAccepted (Inherited from AuthenticationHandler<TOptions>)
SignInScheme
SignOutAccepted (Inherited from AuthenticationHandler<TOptions>)
UrlEncoder (Inherited from AuthenticationHandler<TOptions>)

Methods

AuthenticateAsync() (Inherited from AuthenticationHandler<TOptions>)
AuthenticateAsync(AuthenticateContext) (Inherited from AuthenticationHandler<TOptions>)
BuildRedirectUri(String) (Inherited from AuthenticationHandler<TOptions>)
ChallengeAsync(AuthenticationProperties) (Inherited from AuthenticationHandler<TOptions>)
ChallengeAsync(ChallengeContext) (Inherited from AuthenticationHandler<TOptions>)
CreateEventsAsync()
FinishResponseAsync()

Hook that is called when the response about to be sent

(Inherited from AuthenticationHandler<TOptions>)
ForbidAsync(AuthenticationProperties) (Inherited from AuthenticationHandler<TOptions>)
GenerateCorrelationId(AuthenticationProperties)
GenerateCorrelationId(AuthenticationProperties)
GetDescriptions(DescribeSchemesContext) (Inherited from AuthenticationHandler<TOptions>)
HandleAccessDeniedErrorAsync(AuthenticationProperties)
HandleAuthenticateAsync()
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)
HandleForbiddenAsync(ChallengeContext)
HandleRemoteAuthenticateAsync()

Authenticate the user identity with the identity provider.

The method process the request on the endpoint defined by CallbackPath.

HandleRemoteCallbackAsync()
HandleRequestAsync()
HandleSignInAsync(SignInContext)
HandleSignOutAsync(SignOutContext)
HandleUnauthorizedAsync(ChallengeContext)

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>)
InitializeAsync(AuthenticationScheme, HttpContext)

Initialize the handler, resolve the options and validate them.

(Inherited from AuthenticationHandler<TOptions>)
InitializeAsync(TOptions, HttpContext, ILogger, UrlEncoder)

Initialize is called once per request to contextualize this instance with appropriate state.

(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) (Inherited from AuthenticationHandler<TOptions>)
ShouldHandleRequestAsync()
ShouldHandleScheme(String, Boolean) (Inherited from AuthenticationHandler<TOptions>)
SignInAsync(SignInContext) (Inherited from AuthenticationHandler<TOptions>)
SignOutAsync(SignOutContext) (Inherited from AuthenticationHandler<TOptions>)
ValidateCorrelationId(AuthenticationProperties)
ValidateCorrelationId(AuthenticationProperties)

Applies to