Note

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

Access to this page requires authorization. You can try .

AuthenticationBuilder.AddScheme Method

Definition

Namespace:
Microsoft.AspNetCore.Authentication
Assembly:
Microsoft.AspNetCore.Authentication.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 v2.0.0
Package:
Microsoft.AspNetCore.Authentication v2.1.0
Package:
Microsoft.AspNetCore.Authentication 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

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.

Overloads

AddScheme<TOptions,THandler>(String, Action<TOptions>)

Source:
AuthenticationBuilder.cs
Source:
AuthenticationBuilder.cs
Source:
AuthenticationBuilder.cs

Adds a AuthenticationScheme which can be used by IAuthenticationService.

public:
generic <typename TOptions, typename THandler>
 where TOptions : Microsoft::AspNetCore::Authentication::AuthenticationSchemeOptionsgcnew() where THandler : Microsoft::AspNetCore::Authentication::AuthenticationHandler<TOptions> virtual Microsoft::AspNetCore::Authentication::AuthenticationBuilder ^ AddScheme(System::String ^ authenticationScheme, Action<TOptions> ^ configureOptions);
public virtual Microsoft.AspNetCore.Authentication.AuthenticationBuilder AddScheme<TOptions,THandler>(string authenticationScheme, Action<TOptions>? configureOptions) where TOptions : Microsoft.AspNetCore.Authentication.AuthenticationSchemeOptions, new() where THandler : Microsoft.AspNetCore.Authentication.AuthenticationHandler<TOptions>;
public virtual Microsoft.AspNetCore.Authentication.AuthenticationBuilder AddScheme<TOptions,THandler>(string authenticationScheme, Action<TOptions> configureOptions) where TOptions : Microsoft.AspNetCore.Authentication.AuthenticationSchemeOptions, new() where THandler : Microsoft.AspNetCore.Authentication.AuthenticationHandler<TOptions>;
abstract member AddScheme : string * Action<'Options (requires 'Options :> Microsoft.AspNetCore.Authentication.AuthenticationSchemeOptions and 'Options : (new : unit -> 'Options))> -> Microsoft.AspNetCore.Authentication.AuthenticationBuilder (requires 'Options :> Microsoft.AspNetCore.Authentication.AuthenticationSchemeOptions and 'Options : (new : unit -> 'Options) and 'Handler :> Microsoft.AspNetCore.Authentication.AuthenticationHandler<'Options>)
override this.AddScheme : string * Action<'Options (requires 'Options :> Microsoft.AspNetCore.Authentication.AuthenticationSchemeOptions and 'Options : (new : unit -> 'Options))> -> Microsoft.AspNetCore.Authentication.AuthenticationBuilder (requires 'Options :> Microsoft.AspNetCore.Authentication.AuthenticationSchemeOptions and 'Options : (new : unit -> 'Options) and 'Handler :> Microsoft.AspNetCore.Authentication.AuthenticationHandler<'Options>)
Public Overridable Function AddScheme(Of TOptions As {AuthenticationSchemeOptionsNew}, THandler As {AuthenticationSchemeOptionsNew}) (authenticationScheme As String, configureOptions As Action(Of TOptions)) As AuthenticationBuilder

Type Parameters

TOptions

The AuthenticationSchemeOptions type to configure the handler.

THandler

The AuthenticationHandler<TOptions> used to handle this scheme.

Parameters

authenticationScheme
String

The name of this scheme.

configureOptions
Action<TOptions>

Used to configure the scheme options.

Returns

The builder.

Applies to

AddScheme<TOptions,THandler>(String, String, Action<TOptions>)

Source:
AuthenticationBuilder.cs
Source:
AuthenticationBuilder.cs
Source:
AuthenticationBuilder.cs

Adds a AuthenticationScheme which can be used by IAuthenticationService.

public:
generic <typename TOptions, typename THandler>
 where TOptions : Microsoft::AspNetCore::Authentication::AuthenticationSchemeOptionsgcnew() where THandler : Microsoft::AspNetCore::Authentication::AuthenticationHandler<TOptions> virtual Microsoft::AspNetCore::Authentication::AuthenticationBuilder ^ AddScheme(System::String ^ authenticationScheme, System::String ^ displayName, Action<TOptions> ^ configureOptions);
public virtual Microsoft.AspNetCore.Authentication.AuthenticationBuilder AddScheme<TOptions,THandler>(string authenticationScheme, string? displayName, Action<TOptions>? configureOptions) where TOptions : Microsoft.AspNetCore.Authentication.AuthenticationSchemeOptions, new() where THandler : Microsoft.AspNetCore.Authentication.AuthenticationHandler<TOptions>;
public virtual Microsoft.AspNetCore.Authentication.AuthenticationBuilder AddScheme<TOptions,THandler>(string authenticationScheme, string displayName, Action<TOptions> configureOptions) where TOptions : Microsoft.AspNetCore.Authentication.AuthenticationSchemeOptions, new() where THandler : Microsoft.AspNetCore.Authentication.AuthenticationHandler<TOptions>;
abstract member AddScheme : string * string * Action<'Options (requires 'Options :> Microsoft.AspNetCore.Authentication.AuthenticationSchemeOptions and 'Options : (new : unit -> 'Options))> -> Microsoft.AspNetCore.Authentication.AuthenticationBuilder (requires 'Options :> Microsoft.AspNetCore.Authentication.AuthenticationSchemeOptions and 'Options : (new : unit -> 'Options) and 'Handler :> Microsoft.AspNetCore.Authentication.AuthenticationHandler<'Options>)
override this.AddScheme : string * string * Action<'Options (requires 'Options :> Microsoft.AspNetCore.Authentication.AuthenticationSchemeOptions and 'Options : (new : unit -> 'Options))> -> Microsoft.AspNetCore.Authentication.AuthenticationBuilder (requires 'Options :> Microsoft.AspNetCore.Authentication.AuthenticationSchemeOptions and 'Options : (new : unit -> 'Options) and 'Handler :> Microsoft.AspNetCore.Authentication.AuthenticationHandler<'Options>)
Public Overridable Function AddScheme(Of TOptions As {AuthenticationSchemeOptionsNew}, THandler As {AuthenticationSchemeOptionsNew}) (authenticationScheme As String, displayName As String, configureOptions As Action(Of TOptions)) As AuthenticationBuilder

Type Parameters

TOptions

The AuthenticationSchemeOptions type to configure the handler.

THandler

The AuthenticationHandler<TOptions> used to handle this scheme.

Parameters

authenticationScheme
String

The name of this scheme.

displayName
String

The display name of this scheme.

configureOptions
Action<TOptions>

Used to configure the scheme options.

Returns

The builder.

Applies to

Feedback

Was this page helpful?