Class IdentityBuilderUIExtensions

Default UI extensions to Microsoft.AspNetCore.Identity.IdentityBuilder.

Inheritance

Object

IdentityBuilderUIExtensions

Inherited Members

Object.Equals(Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: IRM.AspNetCore.Identity

Assembly: IRM.AspNetCore.Identity.UI.dll

Syntax

public static class IdentityBuilderUIExtensions

Methods

AddDefaultAdminApi<TListUserType>(IdentityBuilder, String, Action<IdentityAdminUIOptions>)

Adds a default, self-contained API for administrating Identity to the application using MVC in an area named Identity.

Declaration

public static IdentityBuilder AddDefaultAdminApi<TListUserType>(this IdentityBuilder builder, string apiBaseUrl, Action<IdentityAdminUIOptions> setupAction)
    where TListUserType : class, IListUser

Parameters

Microsoft.AspNetCore.Identity.IdentityBuilder builder The Microsoft.AspNetCore.Identity.IdentityBuilder.

String apiBaseUrl The base url for the API, where the user controll exists.

System.Action<IdentityAdminUIOptions> setupAction An action to configure the IdentityAdminUIOptions.

Returns

Microsoft.AspNetCore.Identity.IdentityBuilder The Microsoft.AspNetCore.Identity.IdentityBuilder.

Type Parameters

TListUserType

Remarks

In order to use the default API, the application must be using Microsoft.AspNetCore.Mvc.

AddDefaultAdminUI<TListUserType>(IdentityBuilder, String, Action<IdentityAdminUIOptions>)

Adds a default, self-contained UI for administrating Identity to the application using MVC in an area named Identity.

Declaration

public static IdentityBuilder AddDefaultAdminUI<TListUserType>(this IdentityBuilder builder, string apiBaseUrl, Action<IdentityAdminUIOptions> setupAction)
    where TListUserType : class, IListUser

Parameters

Microsoft.AspNetCore.Identity.IdentityBuilder builder The Microsoft.AspNetCore.Identity.IdentityBuilder.

String apiBaseUrl The base url for the API, where the user controll exists.

System.Action<IdentityAdminUIOptions> setupAction An action to configure the IdentityAdminUIOptions.

Returns

Microsoft.AspNetCore.Identity.IdentityBuilder The Microsoft.AspNetCore.Identity.IdentityBuilder.

Type Parameters

TListUserType

Remarks

In order to use the default UI, the application must be using Microsoft.AspNetCore.Mvc, Microsoft.AspNetCore.StaticFiles and contain a _LoginPartial partial view that can be found by the application.

AddDefaultConfigurationApi<TBuilder>(TBuilder)

Adds a default, self-contained API for administrating Identity system to the application using MVC in an area named Identity.

Declaration

public static TBuilder AddDefaultConfigurationApi<TBuilder>(this TBuilder builder)
    where TBuilder : ExtendedIdentityBuilder

Parameters

TBuilder builder The ExtendedIdentityBuilder.

Returns

TBuilder The ExtendedIdentityBuilder.

Type Parameters

TBuilder

Remarks

In order to use the default API, the application must be using Microsoft.AspNetCore.Mvc.

AddDefaultConfigurationUI<TBuilder>(TBuilder)

Adds a default, self-contained UI for configuring the Identity system to the application using MVC in an area named Identity.

Declaration

public static TBuilder AddDefaultConfigurationUI<TBuilder>(this TBuilder builder)
    where TBuilder : ExtendedIdentityBuilder

Parameters

TBuilder builder The ExtendedIdentityBuilder.

Returns

TBuilder The Microsoft.AspNetCore.Identity.IdentityBuilder.

Type Parameters

TBuilder

AddDefaultSignInUI<TBuilder>(TBuilder, Action<IdentitySignInUIOptions>)

Adds a default, self-contained UI for Identity to the application using MVC in an area named Identity.

Declaration

public static TBuilder AddDefaultSignInUI<TBuilder>(this TBuilder builder, Action<IdentitySignInUIOptions> setupAction)
    where TBuilder : ExtendedIdentityBuilder

Parameters

TBuilder builder The Microsoft.AspNetCore.Identity.IdentityBuilder.

System.Action<IdentitySignInUIOptions> setupAction An action to configure the IdentityUIOptions.

Returns

TBuilder The Microsoft.AspNetCore.Identity.IdentityBuilder.

Type Parameters

TBuilder

Remarks

In order to use the default UI, the application must be using Microsoft.AspNetCore.Mvc, Microsoft.AspNetCore.StaticFiles and contain a _LoginPartial partial view that can be found by the application.

AddDefaultSignInUI<TBuilder>(TBuilder, String)

Adds a default, self-contained UI for Identity to the application using MVC in an area named Identity.

Declaration

public static TBuilder AddDefaultSignInUI<TBuilder>(this TBuilder builder, string applicationName)
    where TBuilder : ExtendedIdentityBuilder

Parameters

TBuilder builder The Microsoft.AspNetCore.Identity.IdentityBuilder.

String applicationName The name of the application (will be displayed in the UI).

Returns

TBuilder The Microsoft.AspNetCore.Identity.IdentityBuilder.

Type Parameters

TBuilder

Remarks

In order to use the default UI, the application must be using Microsoft.AspNetCore.Mvc, Microsoft.AspNetCore.StaticFiles and contain a _LoginPartial partial view that can be found by the application.

AddGravatarAndInitialsPictureProvider<TBuilder>(TBuilder, String)

Adds GravatarAndInitialsUserPictureProvider as IUserPictureProvider.

Declaration

public static TBuilder AddGravatarAndInitialsPictureProvider<TBuilder>(this TBuilder builder, string apiBaseUrl)
    where TBuilder : IdentityBuilder

Parameters

TBuilder builder The Microsoft.AspNetCore.Identity.IdentityBuilder.

String apiBaseUrl The base url for the API, where the user controll exists.

Returns

TBuilder The Microsoft.AspNetCore.Identity.IdentityBuilder.

Type Parameters

TBuilder

AddGravatarPictureProvider<TBuilder>(TBuilder)

Adds GravatarUserPictureProvider as IUserPictureProvider.

Declaration

public static TBuilder AddGravatarPictureProvider<TBuilder>(this TBuilder builder)
    where TBuilder : IdentityBuilder

Parameters

TBuilder builder The Microsoft.AspNetCore.Identity.IdentityBuilder.

Returns

TBuilder The Microsoft.AspNetCore.Identity.IdentityBuilder.

Type Parameters

TBuilder

AddLinkLogin<TBuilder>(TBuilder, Action<LinkLoginOptions>)

Adds support for a user to link an external login. Note that this should not be added before AddDefaultAdminUI or AddDefaultLoginUI.

Declaration

public static TBuilder AddLinkLogin<TBuilder>(this TBuilder builder, Action<LinkLoginOptions> setupAction = null)
    where TBuilder : IdentityBuilder

Parameters

TBuilder builder The Microsoft.AspNetCore.Identity.IdentityBuilder.

System.Action<LinkLoginOptions> setupAction An action to configure the IdentityUIOptions.

Returns

TBuilder The Microsoft.AspNetCore.Identity.IdentityBuilder.

Type Parameters

TBuilder

AddLinkLogin<TBuilder>(TBuilder, String)

Adds support for a user to link an external login. Note that this should not be added before AddDefaultAdminUI or AddDefaultSignInUI.

Declaration

public static TBuilder AddLinkLogin<TBuilder>(this TBuilder builder, string externalLinkLoginUrl)
    where TBuilder : IdentityBuilder

Parameters

TBuilder builder The Microsoft.AspNetCore.Identity.IdentityBuilder.

String externalLinkLoginUrl The url to an external service where the support for linking a login to a user exists.

Returns

TBuilder The Microsoft.AspNetCore.Identity.IdentityBuilder.

Type Parameters

TBuilder