AuthenticationBuilder.AddRemoteScheme<TOptions,THandler> Method

Reference

Definition

Namespace:: Microsoft.AspNetCore.Authentication

Assembly:: Microsoft.AspNetCore.Authentication.dll

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.6

Package:: Microsoft.AspNetCore.App.Ref v7.0.5

Package:: Microsoft.AspNetCore.App.Ref v8.0.0

Source:: AuthenticationBuilder.cs

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

Adds a RemoteAuthenticationHandler<TOptions> based AuthenticationScheme that supports remote authentication which can be used by IAuthenticationService.

public:
generic <typename TOptions, typename THandler>
 where TOptions : Microsoft::AspNetCore::Authentication::RemoteAuthenticationOptionsgcnew() where THandler : Microsoft::AspNetCore::Authentication::RemoteAuthenticationHandler<TOptions> virtual Microsoft::AspNetCore::Authentication::AuthenticationBuilder ^ AddRemoteScheme(System::String ^ authenticationScheme, System::String ^ displayName, Action<TOptions> ^ configureOptions);

public virtual Microsoft.AspNetCore.Authentication.AuthenticationBuilder AddRemoteScheme<TOptions,THandler> (string authenticationScheme, string displayName, Action<TOptions> configureOptions) where TOptions : Microsoft.AspNetCore.Authentication.RemoteAuthenticationOptions, new() where THandler : Microsoft.AspNetCore.Authentication.RemoteAuthenticationHandler<TOptions>;

public virtual Microsoft.AspNetCore.Authentication.AuthenticationBuilder AddRemoteScheme<TOptions,THandler> (string authenticationScheme, string? displayName, Action<TOptions>? configureOptions) where TOptions : Microsoft.AspNetCore.Authentication.RemoteAuthenticationOptions, new() where THandler : Microsoft.AspNetCore.Authentication.RemoteAuthenticationHandler<TOptions>;

abstract member AddRemoteScheme : string * string * Action<'Options (requires 'Options :> Microsoft.AspNetCore.Authentication.RemoteAuthenticationOptions and 'Options : (new : unit -> 'Options))> -> Microsoft.AspNetCore.Authentication.AuthenticationBuilder (requires 'Options :> Microsoft.AspNetCore.Authentication.RemoteAuthenticationOptions and 'Options : (new : unit -> 'Options) and 'Handler :> Microsoft.AspNetCore.Authentication.RemoteAuthenticationHandler<'Options>)
override this.AddRemoteScheme : string * string * Action<'Options (requires 'Options :> Microsoft.AspNetCore.Authentication.RemoteAuthenticationOptions and 'Options : (new : unit -> 'Options))> -> Microsoft.AspNetCore.Authentication.AuthenticationBuilder (requires 'Options :> Microsoft.AspNetCore.Authentication.RemoteAuthenticationOptions and 'Options : (new : unit -> 'Options) and 'Handler :> Microsoft.AspNetCore.Authentication.RemoteAuthenticationHandler<'Options>)

Public Overridable Function AddRemoteScheme(Of TOptions As {RemoteAuthenticationOptionsNew}, THandler As {RemoteAuthenticationOptionsNew}) (authenticationScheme As String, displayName As String, configureOptions As Action(Of TOptions)) As AuthenticationBuilder

Type Parameters

TOptions

The RemoteAuthenticationOptions type to configure the handler.

THandler

The RemoteAuthenticationHandler<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.

Applies to