BlazorSecurityBuilderExtensions.AddExternalAuthentication<TPrincipalProvider>(IBlazorSecurityBuilder, Action<ExternalAuthenticationProviderOptions>) Method

Enables external authentication (custom or OAuth2) in your application.

Namespace: DevExpress.ExpressApp.Blazor.ApplicationBuilder

Assembly: DevExpress.ExpressApp.Blazor.v24.1.dll

NuGet Package: DevExpress.ExpressApp.Blazor

Declaration

C#

public static IBlazorSecurityBuilder AddExternalAuthentication<TPrincipalProvider>(
    this IBlazorSecurityBuilder builder,
    Action<ExternalAuthenticationProviderOptions> configureOptions = null
)
    where TPrincipalProvider : IPrincipalProvider

VB.NET

<ExtensionAttribute>
Public Shared Function AddExternalAuthentication(Of TPrincipalProvider As IPrincipalProvider)(
    builder As IBlazorSecurityBuilder,
    configureOptions As Action(Of ExternalAuthenticationProviderOptions) = Nothing
) As IBlazorSecurityBuilder

Parameters

Name	Type	Description
builder	IBlazorSecurityBuilder	Allows you to enable and configure the Security System in your application, and chain further configuration.

Optional Parameters

Name	Type	Default	Description
configureOptions	Action<DevExpress.ExpressApp.Security.ExternalAuthenticationProviderOptions>	null	Options that you can use to configure external authentication (custom or OAuth2).

Type Parameters

Name	Description
TPrincipalProvider	The IPrincipalProvider service.

Returns

Type	Description
IBlazorSecurityBuilder	Allows you to enable and configure the Security System in your application, and chain further configuration.

Remarks

The following example demonstrates how to use this method:

File: MySolution.Blazor.Server\Startup.cs.

C#

using DevExpress.ExpressApp.ApplicationBuilder;
using DevExpress.ExpressApp.Blazor.ApplicationBuilder;
// ...
public class Startup {
   // ...
    public void ConfigureServices(IServiceCollection services) {
        // ...
        services.AddXaf(Configuration, builder => {
            builder.UseApplication<MySolutionBlazorApplication>();
            // ...
            builder.Security
                .UseIntegratedMode(options => {
                    // ...
                })
                .AddExternalAuthentication<HttpContextPrincipalProvider>(options => {
                    // ...
                })
        });
        // ...
    }
}