Early Preview
This is currently very much a preview. Please feel free to try things out,
but don't be upset if anything is not yet working. Feedback is welcome over on our
GitHub Dicussions page.
class Microsoft.AspNetCore.Authentication.AuthenticationSchemeOptions
Assembly: Microsoft.AspNetCore.Authentication
Inheritance: object → AuthenticationSchemeOptions
Contains the options used by the <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationHandler`1" /> .
Properties
public
string
ClaimsIssuer
Gets or sets the issuer that should be used for any claims that are created
public
object
Events
Instance used for events
public
System.Type
EventsType
If set, will be used as the service type to get the Events instance instead of the property.
public
string
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.
public
string
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.
public
string
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.
public
string
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.
public
string
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.
public
string
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.
public
System.Func<Http.HttpContext, string>
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.
public
System.TimeProvider
TimeProvider
Used for testing.
Methods
public
void
Validate()
Check that the options are valid. Should throw an exception if things are not ok.
public
void
Validate(string scheme)
Checks that the options are valid for a specific scheme
scheme
The scheme being validated.
public
bool
Equals(object obj)
Inherited from object
protected
void
Finalize()
Inherited from object
public
int
GetHashCode()
Inherited from object
protected
object
MemberwiseClone()
Inherited from object
public
string
ToString()
Inherited from object