AuthenticationSchemeProvider Class

Definition

Namespace:: Microsoft.AspNetCore.Authentication

Assembly:: Microsoft.AspNetCore.Authentication.Core.dll

Package:: Microsoft.AspNetCore.App.Ref v10.0.0-preview.7.25380.108

Package:: Microsoft.AspNetCore.Authentication.Core v2.0.0

Package:: Microsoft.AspNetCore.Authentication.Core v2.1.0

Package:: Microsoft.AspNetCore.Authentication.Core 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.6

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:: AuthenticationSchemeProvider.cs

Source:: AuthenticationSchemeProvider.cs

Source:: AuthenticationSchemeProvider.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.

Implements IAuthenticationSchemeProvider.

public ref class AuthenticationSchemeProvider : Microsoft::AspNetCore::Authentication::IAuthenticationSchemeProvider

public class AuthenticationSchemeProvider : Microsoft.AspNetCore.Authentication.IAuthenticationSchemeProvider

type AuthenticationSchemeProvider = class
    interface IAuthenticationSchemeProvider

Public Class AuthenticationSchemeProvider
Implements IAuthenticationSchemeProvider

Inheritance: Object
AuthenticationSchemeProvider

Implements: IAuthenticationSchemeProvider

Constructors

AuthenticationSchemeProvider(IOptions<AuthenticationOptions>, IDictionary<String,AuthenticationScheme>)	Creates an instance of AuthenticationSchemeProvider using the specified `options` and `schemes`.
AuthenticationSchemeProvider(IOptions<AuthenticationOptions>)	Creates an instance of AuthenticationSchemeProvider using the specified `options`.

Methods

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() if that supports sign out.
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?