AuthenticationBuilder.AddScheme Method

Definition

Namespace:

Microsoft.AspNetCore.Authentication

Assembly:

Microsoft.AspNetCore.Authentication.dll

Package:

Microsoft.AspNetCore.App.Ref v8.0.0

Overloads

AddScheme<TOptions,THandler>(String, Action<TOptions>)	Adds a AuthenticationScheme which can be used by IAuthenticationService.
AddScheme<TOptions,THandler>(String, String, Action<TOptions>)	Adds a AuthenticationScheme which can be used by IAuthenticationService.

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

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>;

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

AuthenticationBuilder

The builder.

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

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>;

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

AuthenticationBuilder

The builder.