AuthenticationSchemeOptions Class

Definition

Namespace:

Microsoft.AspNetCore.Authentication

Assembly:

Microsoft.AspNetCore.Authentication.dll

Package:

Microsoft.AspNetCore.App.Ref v9.0.0

Contains the options used by the AuthenticationHandler<TOptions>.

public ref class AuthenticationSchemeOptions

public class AuthenticationSchemeOptions

type AuthenticationSchemeOptions = class

Public Class AuthenticationSchemeOptions

Inheritance

Object

AuthenticationSchemeOptions

Derived

Microsoft.AspNetCore.Authentication.BearerToken.BearerTokenOptions

Microsoft.AspNetCore.Authentication.Certificate.CertificateAuthenticationOptions

Microsoft.AspNetCore.Authentication.Cookies.CookieAuthenticationOptions

Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerOptions

Microsoft.AspNetCore.Authentication.Negotiate.NegotiateOptions

Microsoft.AspNetCore.Authentication.PolicySchemeOptions

Microsoft.AspNetCore.Authentication.RemoteAuthenticationOptions

Constructors

AuthenticationSchemeOptions()

Properties

ClaimsIssuer	Gets or sets the issuer that should be used for any claims that are created
Events	Instance used for events
EventsType	If set, will be used as the service type to get the Events instance instead of the property.
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.
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.
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.
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.
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.
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.
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.
TimeProvider	Used for testing.

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