Class ExtendedIdentityBuilder

Helper functions for configuring extended identity services.

Inheritance

Object

Microsoft.AspNetCore.Identity.IdentityBuilder

ExtendedIdentityBuilder

MultitenantIdentityBuilder

Inherited Members

Microsoft.AspNetCore.Identity.IdentityBuilder.AddUserValidator<TValidator>()

Microsoft.AspNetCore.Identity.IdentityBuilder.AddClaimsPrincipalFactory<TFactory>()

Microsoft.AspNetCore.Identity.IdentityBuilder.AddErrorDescriber<TDescriber>()

Microsoft.AspNetCore.Identity.IdentityBuilder.AddPasswordValidator<TValidator>()

Microsoft.AspNetCore.Identity.IdentityBuilder.AddUserStore<TStore>()

Microsoft.AspNetCore.Identity.IdentityBuilder.AddTokenProvider<TProvider>(System.String)

IdentityBuilder.AddUserManager<TUserManager>()

IdentityBuilder.AddRoles<TRole>()

Microsoft.AspNetCore.Identity.IdentityBuilder.AddRoleValidator<TRole>()

IdentityBuilder.AddPersonalDataProtection<TProtector, TKeyRing>()

Microsoft.AspNetCore.Identity.IdentityBuilder.AddRoleStore<TStore>()

Microsoft.AspNetCore.Identity.IdentityBuilder.AddRoleManager<TRoleManager>()

IdentityBuilder.UserType

IdentityBuilder.RoleType

Microsoft.AspNetCore.Identity.IdentityBuilder.Services

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

Syntax

public class ExtendedIdentityBuilder : IdentityBuilder

Constructors

ExtendedIdentityBuilder(Type, Type, IServiceCollection)

Creates a new instance of ExtendedIdentityBuilder.

Declaration

public ExtendedIdentityBuilder(Type user, Type role, IServiceCollection services)

Parameters

System.Type user The System.Type to use for the users.

System.Type role The System.Type to use for the roles.

Microsoft.Extensions.DependencyInjection.IServiceCollection services The Microsoft.Extensions.DependencyInjection.IServiceCollection to attach to.

ExtendedIdentityBuilder(Type, Type, Type, Type, IServiceCollection)

Creates a new instance of ExtendedIdentityBuilder.

Declaration

public ExtendedIdentityBuilder(Type user, Type role, Type person, Type organisation, IServiceCollection services)

Parameters

System.Type user The System.Type to use for the users.

System.Type role The System.Type to use for the roles.

System.Type person The System.Type to use for the persons.

System.Type organisation The System.Type to use for the organisations.

Microsoft.Extensions.DependencyInjection.IServiceCollection services The Microsoft.Extensions.DependencyInjection.IServiceCollection to attach to.

ExtendedIdentityBuilder(Type, Type, Type, Type, Type, IServiceCollection)

Creates a new instance of ExtendedIdentityBuilder.

Declaration

protected ExtendedIdentityBuilder(Type audit, Type user, Type role, Type person, Type organisation, IServiceCollection services)

Parameters

System.Type audit The System.Type to use for the auditing.

System.Type user The System.Type to use for the users.

System.Type role The System.Type to use for the roles.

System.Type person The System.Type to use for the persons.

System.Type organisation The System.Type to use for the organisations.

Microsoft.Extensions.DependencyInjection.IServiceCollection services The Microsoft.Extensions.DependencyInjection.IServiceCollection to attach to.

Properties

AuditType

Gets the System.Type used for auditing.

Declaration

public Type AuditType { get; }

Property Value

System.Type The System.Type used for auditing.

OrganisationType

Gets the System.Type used for organisations.

Declaration

public Type OrganisationType { get; }

Property Value

System.Type The System.Type used for organisations.

PersonType

Gets the System.Type used for persons.

Declaration

public Type PersonType { get; }

Property Value

System.Type The System.Type used for persons.

Methods

AddAuditCleanupService()

Adds and configures audit cleanup service for the configured audit type.

Declaration

public ExtendedIdentityBuilder AddAuditCleanupService()

Returns

ExtendedIdentityBuilder The current ExtendedIdentityBuilder instance.

AddAuditCleanupService(Type)

Adds and configures audit cleanup service for the supplyed audit type.

Declaration

protected void AddAuditCleanupService(Type auditType)

Parameters

System.Type auditType The type used for audit.

AddAuditing<TAudit>()

Adds and configures auditing for the specified Auditing type.

Declaration

public virtual ExtendedIdentityBuilder AddAuditing<TAudit>()

Returns

ExtendedIdentityBuilder An ExtendedIdentityBuilder for creating and configuring the identity system.

Type Parameters

TAudit The type representing a Audit in the system.

AddAuditStore<T>()

Adds an IAuditStore<TAudit> for the AuditType.

Declaration

public virtual ExtendedIdentityBuilder AddAuditStore<T>()
    where T : class

Returns

ExtendedIdentityBuilder The current ExtendedIdentityBuilder instance.

Type Parameters

T The audit store type.

AddClaimFilter<TFilter, TUser>()

Adds a IClaimFilter<TUser> that can be used to manipulate the claims for the user signing in.

Declaration

public ExtendedIdentityBuilder AddClaimFilter<TFilter, TUser>()
    where TFilter : class, IClaimFilter<TUser> where TUser : class, IUser

Returns

ExtendedIdentityBuilder The current ExtendedIdentityBuilder instance.

Type Parameters

TFilter The type of sign-in claim filter to use.

TUser The type of user.

AddClaimFilter<TFilter, TUser>(Int32)

Adds a IClaimFilter<TUser> that can be used to manipulate the claims for the user signing in.

Declaration

public ExtendedIdentityBuilder AddClaimFilter<TFilter, TUser>(int order)
    where TFilter : class, IClaimFilter<TUser> where TUser : class, IUser

Parameters

System.Int32 order

Returns

ExtendedIdentityBuilder The current ExtendedIdentityBuilder instance.

Type Parameters

TFilter The type of sign-in claim filter to use.

TUser The type of user.

AddIPAddressLocation(IPAddressLocationOptions)

Adds and configures IP address location support.

Declaration

public virtual ExtendedIdentityBuilder AddIPAddressLocation(IPAddressLocationOptions options = null)

Parameters

IPAddressLocationOptions options

Returns

ExtendedIdentityBuilder An ExtendedIdentityBuilder for creating and configuring the identity system.

AddIPAddressLocationStore<T>()

Adds an IIPAddressLocationStore.

Declaration

public virtual ExtendedIdentityBuilder AddIPAddressLocationStore<T>()
    where T : class

Returns

ExtendedIdentityBuilder The current ExtendedIdentityBuilder instance.

Type Parameters

T The audit store type.

AddOrganisationManager<TOrganisationManager>()

Adds a OrganisationManager<TOrganisation> for the OrganisationType.

Declaration

public virtual ExtendedIdentityBuilder AddOrganisationManager<TOrganisationManager>()
    where TOrganisationManager : class

Returns

ExtendedIdentityBuilder The current ExtendedIdentityBuilder instance.

Type Parameters

TOrganisationManager The type of the organisation manager to add.

AddOrganisations<TOrganisation>()

Adds Organisation related services for TOrganisation, including IOrganisationValidator, OrganisationManager.

Declaration

public virtual ExtendedIdentityBuilder AddOrganisations<TOrganisation>()
    where TOrganisation : class, IOrganisation

Returns

ExtendedIdentityBuilder The current ExtendedIdentityBuilder instance.

Type Parameters

TOrganisation The organisation type.

AddOrganisationStore<T>()

Adds an IOrganisationStore<TOrganisation> for the OrganisationType.

Declaration

public virtual ExtendedIdentityBuilder AddOrganisationStore<T>()
    where T : class

Returns

ExtendedIdentityBuilder The current ExtendedIdentityBuilder instance.

Type Parameters

T The organisation store type.

AddPersonManager<TPersonManager>()

Adds a PersonManager<TPerson> for the PersonType.

Declaration

public virtual ExtendedIdentityBuilder AddPersonManager<TPersonManager>()
    where TPersonManager : class

Returns

ExtendedIdentityBuilder The current ExtendedIdentityBuilder instance.

Type Parameters

TPersonManager The type of the person manager to add.

AddPersons<TPerson>()

Adds Person related services for TPerson, including IPersonValidator, PersonManager.

Declaration

public virtual ExtendedIdentityBuilder AddPersons<TPerson>()
    where TPerson : class, IPerson

Returns

ExtendedIdentityBuilder The current ExtendedIdentityBuilder instance.

Type Parameters

TPerson The person type.

AddPersonStore<T>()

Adds an IPersonStore<TPerson> for the PersonType.

Declaration

public virtual ExtendedIdentityBuilder AddPersonStore<T>()
    where T : class

Returns

ExtendedIdentityBuilder The current ExtendedIdentityBuilder instance.

Type Parameters

T The person store type.

AddPersonValidator<TPersonValidator>()

Adds an IPersonValidator<TPerson> for the PersonType.

Declaration

public virtual ExtendedIdentityBuilder AddPersonValidator<TPersonValidator>()
    where TPersonValidator : class

Returns

ExtendedIdentityBuilder The current ExtendedIdentityBuilder instance.

Type Parameters

TPersonValidator The person validator type.

AddTemplateRoleFactory<TFactory>()

Adds a template role factory for the RoleType.

Declaration

public ExtendedIdentityBuilder AddTemplateRoleFactory<TFactory>()
    where TFactory : class

Returns

ExtendedIdentityBuilder The current ExtendedIdentityBuilder instance.

Type Parameters

TFactory The type of template role factory to add.

AddTokenProvider(String, Type)

Adds a token provider for the UserType.

Declaration

public override IdentityBuilder AddTokenProvider(string providerName, Type provider)

Parameters

String providerName The name of the provider to add.

System.Type provider The type of the Microsoft.AspNetCore.Identity.IUserTwoFactorTokenProvider`1 to add.

Returns

Microsoft.AspNetCore.Identity.IdentityBuilder The current ExtendedIdentityBuilder instance.

Overrides

IdentityBuilder.AddTokenProvider(String, Type)

AddUserPictureProvider<TUserPictureProvider>()

Adds a IUserPictureProvider used to get pictures for users.

Declaration

public virtual ExtendedIdentityBuilder AddUserPictureProvider<TUserPictureProvider>()
    where TUserPictureProvider : class, IUserPictureProvider

Returns

ExtendedIdentityBuilder The current ExtendedIdentityBuilder instance.

Type Parameters

TUserPictureProvider The type of user picture provider to add.

Extension Methods

IdentityBuilderExtensions.AddIP2LocationLiteDatabase<T>(T, IPAddressLocationOptions)

ExtendedIdentityBuilderExtensions.AddOrganisationStore(ExtendedIdentityBuilder, Type)

ExtendedIdentityBuilderExtensions.AddPersonStore(ExtendedIdentityBuilder, Type)

ExtendedIdentityBuilderExtensions.AddOrganisationCaches(ExtendedIdentityBuilder, Type, Type)

ExtendedIdentityBuilderExtensions.AddOrganisationStoreCache(ExtendedIdentityBuilder)

ExtendedIdentityBuilderExtensions.AddOrganisationStoreCache(ExtendedIdentityBuilder, Type)

ExtendedIdentityBuilderExtensions.AddPersonStoreCache(ExtendedIdentityBuilder)

ExtendedIdentityBuilderExtensions.AddPersonStoreCache(ExtendedIdentityBuilder, Type)

ExtendedIdentityBuilderExtensions.AddUserClaimsPrincipalCache(ExtendedIdentityBuilder)

IdentityBuilderCompatShimExtensions.AddMembershipPasswordHasher(IdentityBuilder)

IdentityBuilderCompatShimExtensions.AddSimpleMembershipPasswordHasher(IdentityBuilder)

IRM.AspNetCore.Identity.ExtendedIdentityBuilderExtensions.AddUserStoreCache(IRM.AspNetCore.Identity.ExtendedIdentityBuilder)

IdentityEntityFrameworkBuilderExtensions.AddEntityFrameworkStores<TContext>(ExtendedIdentityBuilder)

IdentityEntityFrameworkBuilderExtensions.AddEntityFrameworkSearchStore(ExtendedIdentityBuilder)

IdentityEntityFrameworkBuilderExtensions.AddEntityFrameworkSearchStore<TListUser, TContext>(ExtendedIdentityBuilder)

IdentityEntityFrameworkBuilderExtensions.AddEntityFrameworkOrganisationStores<TContext>(ExtendedIdentityBuilder)

IdentityEntityFrameworkBuilderExtensions.AddCachedEntityFrameworkOrganisationStores<TContext>(ExtendedIdentityBuilder)

IRM.AspNetCore.Identity.IdentityBuilderExtensions.AddIpstackLocationService<T>(T, System.String, IRM.AspNetCore.Identity.IPAddressLocationOptions)

IRM.AspNetCore.Identity.IdentityBuilderExtensions.AddIpstackLocationService<T>(T, System.String, System.String, IRM.AspNetCore.Identity.IPAddressLocationOptions)

IdentityBuilderMailExtensions.AddCoreEmailServices(IdentityBuilder, Action<EmailOptions>)

IdentityBuilderMailExtensions.AddSimpleEmailServices(IdentityBuilder, Action<EmailOptions>)

IdentityBuilderUIExtensions.AddDefaultSignInUI<TBuilder>(TBuilder, String)

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

IdentityBuilderUIExtensions.AddDefaultConfigurationUI<TBuilder>(TBuilder)

IdentityBuilderUIExtensions.AddDefaultConfigurationApi<TBuilder>(TBuilder)

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

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

IdentityBuilderUIExtensions.AddGravatarAndInitialsPictureProvider<TBuilder>(TBuilder, String)

IdentityBuilderUIExtensions.AddGravatarPictureProvider<TBuilder>(TBuilder)

IdentityBuilderUIExtensions.AddLinkLogin<TBuilder>(TBuilder, String)

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