WsFederationHandler Class

Definition

Namespace:

Microsoft.AspNetCore.Authentication.WsFederation

Assembly:

Microsoft.AspNetCore.Authentication.WsFederation.dll

Package:

Microsoft.AspNetCore.Authentication.WsFederation v9.0.2

Source:

WsFederationHandler.cs

A per-request authentication handler for the WsFederation.

public ref class WsFederationHandler : Microsoft::AspNetCore::Authentication::RemoteAuthenticationHandler<Microsoft::AspNetCore::Authentication::WsFederation::WsFederationOptions ^>, Microsoft::AspNetCore::Authentication::IAuthenticationSignOutHandler

public class WsFederationHandler : Microsoft.AspNetCore.Authentication.RemoteAuthenticationHandler<Microsoft.AspNetCore.Authentication.WsFederation.WsFederationOptions>, Microsoft.AspNetCore.Authentication.IAuthenticationSignOutHandler

type WsFederationHandler = class
    inherit RemoteAuthenticationHandler<WsFederationOptions>
    interface IAuthenticationSignOutHandler
    interface IAuthenticationHandler

Public Class WsFederationHandler
Inherits RemoteAuthenticationHandler(Of WsFederationOptions)
Implements IAuthenticationSignOutHandler

Inheritance

Object

AuthenticationHandler<TOptions>

RemoteAuthenticationHandler<WsFederationOptions>

WsFederationHandler

Implements

IAuthenticationHandler IAuthenticationSignOutHandler

Constructors

WsFederationHandler(IOptionsMonitor<WsFederationOptions>, ILoggerFactory, UrlEncoder, ISystemClock)	Obsolete. Creates a new WsFederationAuthenticationHandler
WsFederationHandler(IOptionsMonitor<WsFederationOptions>, ILoggerFactory, UrlEncoder)	Creates a new WsFederationAuthenticationHandler

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.
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>)
SignInScheme	The authentication scheme used by default for signin. (Inherited from RemoteAuthenticationHandler<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.
ForbidAsync(AuthenticationProperties)	Forbid the current request. (Inherited from AuthenticationHandler<TOptions>)
GenerateCorrelationId(AuthenticationProperties)	Produces a cookie containing a nonce used to correlate the current remote authentication request. (Inherited from RemoteAuthenticationHandler<TOptions>)
HandleAccessDeniedErrorAsync(AuthenticationProperties)	Derived types may override this method to handle access denied errors. (Inherited from RemoteAuthenticationHandler<TOptions>)
HandleAuthenticateAsync()	Allows derived types to handle authentication. (Inherited from RemoteAuthenticationHandler<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)	Handles Challenge
HandleForbiddenAsync(AuthenticationProperties)	Override this method to handle Forbid. (Inherited from RemoteAuthenticationHandler<TOptions>)
HandleRemoteAuthenticateAsync()	Invoked to process incoming authentication messages.
HandleRemoteSignOutAsync()	Handles wsignoutcleanup1.0 messages sent to the RemoteSignOutPath
HandleRequestAsync()	Overridden to handle remote signout requests
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>)
ShouldHandleRequestAsync()	Gets a value that determines if the current authentication request should be handled by HandleRequestAsync(). (Inherited from RemoteAuthenticationHandler<TOptions>)
SignOutAsync(AuthenticationProperties)	Handles Signout
ValidateCorrelationId(AuthenticationProperties)	Validates that the current request correlates with the current remote authentication request. (Inherited from RemoteAuthenticationHandler<TOptions>)