RemoteAuthenticationHandler<TOptions> RemoteAuthenticationHandler<TOptions> RemoteAuthenticationHandler<TOptions> 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 IAuthenticationRequestHandler
    interface IAuthenticationHandler
Public MustInherit Class RemoteAuthenticationHandler(Of TOptions)
Inherits AuthenticationHandler(Of TOptions)
Implements IAuthenticationRequestHandler
Type Parameters
TOptions
Inheritance
RemoteAuthenticationHandler<TOptions>RemoteAuthenticationHandler<TOptions>RemoteAuthenticationHandler<TOptions>RemoteAuthenticationHandler<TOptions>
Derived
Implements

Constructors

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

Properties

ChallengeCalled ChallengeCalled ChallengeCalled ChallengeCalled Inherited from AuthenticationHandler<TOptions>
ClaimsIssuer ClaimsIssuer ClaimsIssuer ClaimsIssuer Inherited from AuthenticationHandler<TOptions>
Clock Clock Clock Clock Inherited from AuthenticationHandler<TOptions>
Context Context Context Context Inherited from AuthenticationHandler<TOptions>
CurrentUri CurrentUri CurrentUri CurrentUri Inherited from AuthenticationHandler<TOptions>
Events Events Events 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 InitializeResult InitializeResult InitializeResult Inherited from AuthenticationHandler<TOptions>
Logger Logger Logger Logger Inherited from AuthenticationHandler<TOptions>
Options Options Options Options Inherited from AuthenticationHandler<TOptions>
OptionsMonitor OptionsMonitor OptionsMonitor OptionsMonitor Inherited from AuthenticationHandler<TOptions>
OriginalPath OriginalPath OriginalPath OriginalPath Inherited from AuthenticationHandler<TOptions>
OriginalPathBase OriginalPathBase OriginalPathBase OriginalPathBase Inherited from AuthenticationHandler<TOptions>
PriorHandler PriorHandler PriorHandler PriorHandler Inherited from AuthenticationHandler<TOptions>
Request Request Request Request Inherited from AuthenticationHandler<TOptions>
Response Response Response Response Inherited from AuthenticationHandler<TOptions>
Scheme Scheme Scheme Scheme Inherited from AuthenticationHandler<TOptions>
SignInAccepted SignInAccepted SignInAccepted SignInAccepted Inherited from AuthenticationHandler<TOptions>
SignInScheme SignInScheme SignInScheme SignInScheme
SignOutAccepted SignOutAccepted SignOutAccepted SignOutAccepted Inherited from AuthenticationHandler<TOptions>
UrlEncoder UrlEncoder UrlEncoder UrlEncoder Inherited from AuthenticationHandler<TOptions>

Methods

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

Hook that is called when the response about to be sent

(Inherited from AuthenticationHandler<TOptions>)
ForbidAsync(AuthenticationProperties) ForbidAsync(AuthenticationProperties) ForbidAsync(AuthenticationProperties) ForbidAsync(AuthenticationProperties) Inherited from AuthenticationHandler<TOptions>
GenerateCorrelationId(AuthenticationProperties) GenerateCorrelationId(AuthenticationProperties) GenerateCorrelationId(AuthenticationProperties) GenerateCorrelationId(AuthenticationProperties)
GenerateCorrelationId(AuthenticationProperties) GenerateCorrelationId(AuthenticationProperties) GenerateCorrelationId(AuthenticationProperties) GenerateCorrelationId(AuthenticationProperties)
GetDescriptions(DescribeSchemesContext) GetDescriptions(DescribeSchemesContext) GetDescriptions(DescribeSchemesContext) GetDescriptions(DescribeSchemesContext) Inherited from AuthenticationHandler<TOptions>
HandleAuthenticateAsync() HandleAuthenticateAsync() HandleAuthenticateAsync() HandleAuthenticateAsync()
HandleAuthenticateOnceAsync() HandleAuthenticateOnceAsync() HandleAuthenticateOnceAsync() HandleAuthenticateOnceAsync()

Used to ensure HandleAuthenticateAsync is only invoked once. The subsequent calls will return the same authenticate result.

(Inherited from AuthenticationHandler<TOptions>)
HandleAuthenticateOnceSafeAsync() HandleAuthenticateOnceSafeAsync() HandleAuthenticateOnceSafeAsync() 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) HandleChallengeAsync(AuthenticationProperties) HandleChallengeAsync(AuthenticationProperties) 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(AuthenticationProperties) HandleForbiddenAsync(AuthenticationProperties) HandleForbiddenAsync(AuthenticationProperties)
HandleForbiddenAsync(ChallengeContext) HandleForbiddenAsync(ChallengeContext) HandleForbiddenAsync(ChallengeContext) HandleForbiddenAsync(ChallengeContext)
HandleRemoteAuthenticateAsync() HandleRemoteAuthenticateAsync() HandleRemoteAuthenticateAsync() HandleRemoteAuthenticateAsync()

Authenticate the user identity with the identity provider.

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

HandleRemoteCallbackAsync() HandleRemoteCallbackAsync() HandleRemoteCallbackAsync() HandleRemoteCallbackAsync()
HandleRequestAsync() HandleRequestAsync() HandleRequestAsync() HandleRequestAsync()
HandleSignInAsync(SignInContext) HandleSignInAsync(SignInContext) HandleSignInAsync(SignInContext) HandleSignInAsync(SignInContext)
HandleSignOutAsync(SignOutContext) HandleSignOutAsync(SignOutContext) HandleSignOutAsync(SignOutContext) HandleSignOutAsync(SignOutContext)
HandleUnauthorizedAsync(ChallengeContext) HandleUnauthorizedAsync(ChallengeContext) HandleUnauthorizedAsync(ChallengeContext) 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) InitializeAsync(AuthenticationScheme, HttpContext) InitializeAsync(AuthenticationScheme, HttpContext) InitializeAsync(AuthenticationScheme, HttpContext)

Initialize the handler, resolve the options and validate them.

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

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

(Inherited from AuthenticationHandler<TOptions>)
InitializeEventsAsync() InitializeEventsAsync() InitializeEventsAsync() InitializeEventsAsync()

Initializes the events object, called once per request by InitializeAsync(AuthenticationScheme, HttpContext).

(Inherited from AuthenticationHandler<TOptions>)
InitializeHandlerAsync() InitializeHandlerAsync() InitializeHandlerAsync() InitializeHandlerAsync()

Called after options/events have been initialized for the handler to finish initializing itself.

(Inherited from AuthenticationHandler<TOptions>)
ResolveTarget(String) ResolveTarget(String) ResolveTarget(String) ResolveTarget(String) Inherited from AuthenticationHandler<TOptions>
ShouldHandleRequestAsync() ShouldHandleRequestAsync() ShouldHandleRequestAsync() ShouldHandleRequestAsync()
ShouldHandleScheme(String, Boolean) ShouldHandleScheme(String, Boolean) ShouldHandleScheme(String, Boolean) ShouldHandleScheme(String, Boolean) Inherited from AuthenticationHandler<TOptions>
SignInAsync(SignInContext) SignInAsync(SignInContext) SignInAsync(SignInContext) SignInAsync(SignInContext) Inherited from AuthenticationHandler<TOptions>
SignOutAsync(SignOutContext) SignOutAsync(SignOutContext) SignOutAsync(SignOutContext) SignOutAsync(SignOutContext) Inherited from AuthenticationHandler<TOptions>
ValidateCorrelationId(AuthenticationProperties) ValidateCorrelationId(AuthenticationProperties) ValidateCorrelationId(AuthenticationProperties) ValidateCorrelationId(AuthenticationProperties)
ValidateCorrelationId(AuthenticationProperties) ValidateCorrelationId(AuthenticationProperties) ValidateCorrelationId(AuthenticationProperties) ValidateCorrelationId(AuthenticationProperties)

Applies to