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.AuthenticationOptions
Assembly: Microsoft.AspNetCore.Authentication.Abstractions
Inheritance: object → AuthenticationOptions
Options to configure authentication.
Properties
Schemes
Returns the schemes in the order they were added (important for request handling priority)
public
System.Collections.Generic.IDictionary<string, AuthenticationSchemeBuilder>
SchemeMap
Maps schemes by name.
public
string
DefaultScheme
Used as the fallback default scheme for all the other defaults.
public
string
DefaultAuthenticateScheme
Used as the default scheme by <see cref="M:Microsoft.AspNetCore.Authentication.IAuthenticationService.AuthenticateAsync(Microsoft.AspNetCore.Http.HttpContext,System.String)" /> .
public
string
DefaultSignInScheme
Used as the default scheme by <see cref="M:Microsoft.AspNetCore.Authentication.IAuthenticationService.SignInAsync(Microsoft.AspNetCore.Http.HttpContext,System.String,System.Security.Claims.ClaimsPrincipal,Microsoft.AspNetCore.Authentication.AuthenticationProperties)" /> .
public
string
DefaultSignOutScheme
Used as the default scheme by <see cref="M:Microsoft.AspNetCore.Authentication.IAuthenticationService.SignOutAsync(Microsoft.AspNetCore.Http.HttpContext,System.String,Microsoft.AspNetCore.Authentication.AuthenticationProperties)" /> .
public
string
DefaultChallengeScheme
Used as the default scheme by <see cref="M:Microsoft.AspNetCore.Authentication.IAuthenticationService.ChallengeAsync(Microsoft.AspNetCore.Http.HttpContext,System.String,Microsoft.AspNetCore.Authentication.AuthenticationProperties)" /> .
public
string
DefaultForbidScheme
Used as the default scheme by <see cref="M:Microsoft.AspNetCore.Authentication.IAuthenticationService.ForbidAsync(Microsoft.AspNetCore.Http.HttpContext,System.String,Microsoft.AspNetCore.Authentication.AuthenticationProperties)" /> .
public
bool
RequireAuthenticatedSignIn
If true, SignIn should throw if attempted with a user who is not authenticated.
A user is considered authenticated if <see cref="P:System.Security.Claims.ClaimsIdentity.IsAuthenticated" /> returns <see langword="true" /> for the <see cref="T:System.Security.Claims.ClaimsPrincipal" /> associated with the HTTP request.
Methods
public
void
AddScheme(string name,
System.Action<AuthenticationSchemeBuilder> configureBuilder)
Adds an <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationScheme" /> .
name
The name of the scheme being added.
configureBuilder
Configures the scheme.
public
void
AddScheme(string name,
string displayName)
Adds an <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationScheme" /> .
name
The name of the scheme being added.
displayName
The display name for the scheme.
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