RemoteAuthenticationOptions Class

Definition

Namespace:

Microsoft.AspNetCore.Authentication

Assembly:

Microsoft.AspNetCore.Authentication.dll

Package:

Microsoft.AspNetCore.App.Ref v8.0.0

Source:

RemoteAuthenticationOptions.cs

Contains the options used by the RemoteAuthenticationHandler<TOptions>.

public ref class RemoteAuthenticationOptions : Microsoft::AspNetCore::Authentication::AuthenticationSchemeOptions

public class RemoteAuthenticationOptions : Microsoft.AspNetCore.Authentication.AuthenticationSchemeOptions

type RemoteAuthenticationOptions = class
    inherit AuthenticationSchemeOptions

Public Class RemoteAuthenticationOptions
Inherits AuthenticationSchemeOptions

Inheritance

Object

AuthenticationSchemeOptions

RemoteAuthenticationOptions

Derived

Microsoft.AspNetCore.Authentication.OAuth.OAuthOptions

Microsoft.AspNetCore.Authentication.OpenIdConnect.OpenIdConnectOptions

Microsoft.AspNetCore.Authentication.Twitter.TwitterOptions

Microsoft.AspNetCore.Authentication.WsFederation.WsFederationOptions

Constructors

RemoteAuthenticationOptions()

Initializes a new RemoteAuthenticationOptions.

Properties

AccessDeniedPath	Gets or sets the optional path the user agent is redirected to if the user doesn't approve the authorization demand requested by the remote server. This property is not set by default. In this case, an exception is thrown if an access_denied response is returned by the remote authorization server.
Backchannel	Used to communicate with the remote identity provider.
BackchannelHttpHandler	The HttpMessageHandler used to communicate with remote identity provider. This cannot be set at the same time as BackchannelCertificateValidator unless the value can be downcast to a WebRequestHandler.
BackchannelTimeout	Gets or sets timeout value in milliseconds for back channel communications with the remote identity provider.
CallbackPath	The request path within the application's base path where the user-agent will be returned. The middleware will process this request when it arrives.
ClaimsIssuer	Gets or sets the issuer that should be used for any claims that are created (Inherited from AuthenticationSchemeOptions)
CorrelationCookie	Determines the settings used to create the correlation cookie before the cookie gets added to the response.
DataProtectionProvider	Gets or sets the type used to secure data.
Events	Gets or sets a value that allows subscribing to remote authentication events.
EventsType	If set, will be used as the service type to get the Events instance instead of the property. (Inherited from AuthenticationSchemeOptions)
ForwardAuthenticate	If set, this specifies the target scheme that this scheme should forward AuthenticateAsync calls to. For example Context.AuthenticateAsync("ThisScheme") => Context.AuthenticateAsync("ForwardAuthenticateValue"); Set the target to the current scheme to disable forwarding and allow normal processing. (Inherited from AuthenticationSchemeOptions)
ForwardChallenge	If set, this specifies the target scheme that this scheme should forward ChallengeAsync calls to. For example Context.ChallengeAsync("ThisScheme") => Context.ChallengeAsync("ForwardChallengeValue"); Set the target to the current scheme to disable forwarding and allow normal processing. (Inherited from AuthenticationSchemeOptions)
ForwardDefault	If set, this specifies a default scheme that authentication handlers should forward all authentication operations to by default. The default forwarding logic will check the most specific ForwardAuthenticate/Challenge/Forbid/SignIn/SignOut setting first, followed by checking the ForwardDefaultSelector, followed by ForwardDefault. The first non null result will be used as the target scheme to forward to. (Inherited from AuthenticationSchemeOptions)
ForwardDefaultSelector	Used to select a default scheme for the current request that authentication handlers should forward all authentication operations to by default. The default forwarding logic will check the most specific ForwardAuthenticate/Challenge/Forbid/SignIn/SignOut setting first, followed by checking the ForwardDefaultSelector, followed by ForwardDefault. The first non null result will be used as the target scheme to forward to. (Inherited from AuthenticationSchemeOptions)
ForwardForbid	If set, this specifies the target scheme that this scheme should forward ForbidAsync calls to. For example Context.ForbidAsync("ThisScheme") => Context.ForbidAsync("ForwardForbidValue"); Set the target to the current scheme to disable forwarding and allow normal processing. (Inherited from AuthenticationSchemeOptions)
ForwardSignIn	If set, this specifies the target scheme that this scheme should forward SignInAsync calls to. For example Context.SignInAsync("ThisScheme") => Context.SignInAsync("ForwardSignInValue"); Set the target to the current scheme to disable forwarding and allow normal processing. (Inherited from AuthenticationSchemeOptions)
ForwardSignOut	If set, this specifies the target scheme that this scheme should forward SignOutAsync calls to. For example Context.SignOutAsync("ThisScheme") => Context.SignOutAsync("ForwardSignOutValue"); Set the target to the current scheme to disable forwarding and allow normal processing. (Inherited from AuthenticationSchemeOptions)
RemoteAuthenticationTimeout	Gets or sets the time limit for completing the authentication flow (15 minutes by default).
ReturnUrlParameter	Gets or sets the name of the parameter used to convey the original location of the user before the remote challenge was triggered up to the access denied page. This property is only used when the AccessDeniedPath is explicitly specified.
SaveTokens	Defines whether access and refresh tokens should be stored in the AuthenticationProperties after a successful authorization. This property is set to false by default to reduce the size of the final authentication cookie.
SignInScheme	Gets or sets the authentication scheme corresponding to the middleware responsible for persisting user's identity after a successful authentication. This value typically corresponds to a cookie middleware registered in the Startup class. When omitted, DefaultSignInScheme is used as a fallback value.
TimeProvider	Used for testing. (Inherited from AuthenticationSchemeOptions)

Methods

Validate()	Check that the options are valid. Should throw an exception if things are not ok.
Validate(String)	Checks that the options are valid for a specific scheme