Note

Access to this page requires authorization. You can try signing in or .

Access to this page requires authorization. You can try .

IAuthenticationSchemeProvider Interface

Definition

Namespace:
Microsoft.AspNetCore.Authentication
Assembly:
Microsoft.AspNetCore.Authentication.Abstractions.dll
Package:
Microsoft.AspNetCore.App.Ref v10.0.0
Package:
Microsoft.AspNetCore.App.Ref v11.0.0-preview.4.26230.115
Package:
Microsoft.AspNetCore.Authentication.Abstractions v2.0.0
Package:
Microsoft.AspNetCore.Authentication.Abstractions v2.1.0
Package:
Microsoft.AspNetCore.Authentication.Abstractions v2.2.0
Package:
Microsoft.AspNetCore.App.Ref v3.0.1
Package:
Microsoft.AspNetCore.App.Ref v3.1.10
Package:
Microsoft.AspNetCore.App.Ref v5.0.0
Package:
Microsoft.AspNetCore.App.Ref v6.0.36
Package:
Microsoft.AspNetCore.App.Ref v7.0.5
Package:
Microsoft.AspNetCore.App.Ref v8.0.19
Package:
Microsoft.AspNetCore.App.Ref v9.0.8
Source:
IAuthenticationSchemeProvider.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Responsible for managing what authenticationSchemes are supported.

public interface class IAuthenticationSchemeProvider
public interface IAuthenticationSchemeProvider
type IAuthenticationSchemeProvider = interface
Public Interface IAuthenticationSchemeProvider
Derived

Methods

Name Description
AddScheme(AuthenticationScheme)

Registers a scheme for use by IAuthenticationService.
GetAllSchemesAsync()

Returns all currently registered AuthenticationSchemes.
GetDefaultAuthenticateSchemeAsync()

Returns the scheme that will be used by default for AuthenticateAsync(HttpContext, String). This is typically specified via DefaultAuthenticateScheme. Otherwise, this will fallback to DefaultScheme.
GetDefaultChallengeSchemeAsync()

Returns the scheme that will be used by default for ChallengeAsync(HttpContext, String, AuthenticationProperties). This is typically specified via DefaultChallengeScheme. Otherwise, this will fallback to DefaultScheme.
GetDefaultForbidSchemeAsync()

Returns the scheme that will be used by default for ForbidAsync(HttpContext, String, AuthenticationProperties). This is typically specified via DefaultForbidScheme. Otherwise, this will fallback to GetDefaultChallengeSchemeAsync() .
GetDefaultSignInSchemeAsync()

Returns the scheme that will be used by default for SignInAsync(HttpContext, String, ClaimsPrincipal, AuthenticationProperties). This is typically specified via DefaultSignInScheme. Otherwise, this will fallback to DefaultScheme.
GetDefaultSignOutSchemeAsync()

Returns the scheme that will be used by default for SignOutAsync(HttpContext, String, AuthenticationProperties). This is typically specified via DefaultSignOutScheme. Otherwise, this will fallback to GetDefaultSignInSchemeAsync() .
GetRequestHandlerSchemesAsync()

Returns the schemes in priority order for request handling.
GetSchemeAsync(String)

Returns the AuthenticationScheme matching the name, or null.
RemoveScheme(String)

Removes a scheme, preventing it from being used by IAuthenticationService.
TryAddScheme(AuthenticationScheme)

Registers a scheme for use by IAuthenticationService.

Applies to

Feedback

Was this page helpful?