Show / Hide Table of Contents

Class IdentityUserStore

Inheritance
object
IdentityUserStore
IdentityProUserStore
Implements
IUserLoginStore<IdentityUser>
IUserRoleStore<IdentityUser>
IUserClaimStore<IdentityUser>
IUserPasswordStore<IdentityUser>
IUserSecurityStampStore<IdentityUser>
IUserEmailStore<IdentityUser>
IUserLockoutStore<IdentityUser>
IUserPhoneNumberStore<IdentityUser>
IUserTwoFactorStore<IdentityUser>
IUserAuthenticationTokenStore<IdentityUser>
IUserAuthenticatorKeyStore<IdentityUser>
IUserTwoFactorRecoveryCodeStore<IdentityUser>
IUserStore<IdentityUser>
IDisposable
ITransientDependency
Inherited Members
object.GetType()
object.MemberwiseClone()
object.ToString()
object.Equals(object)
object.Equals(object, object)
object.ReferenceEquals(object, object)
object.GetHashCode()
Namespace: Volo.Abp.Identity
Assembly: Volo.Abp.Identity.Domain.dll
Syntax
public class IdentityUserStore : IUserLoginStore<IdentityUser>, IUserRoleStore<IdentityUser>, IUserClaimStore<IdentityUser>, IUserPasswordStore<IdentityUser>, IUserSecurityStampStore<IdentityUser>, IUserEmailStore<IdentityUser>, IUserLockoutStore<IdentityUser>, IUserPhoneNumberStore<IdentityUser>, IUserTwoFactorStore<IdentityUser>, IUserAuthenticationTokenStore<IdentityUser>, IUserAuthenticatorKeyStore<IdentityUser>, IUserTwoFactorRecoveryCodeStore<IdentityUser>, IUserStore<IdentityUser>, IDisposable, ITransientDependency

Constructors

IdentityUserStore(IIdentityUserRepository, IIdentityRoleRepository, IGuidGenerator, ILogger<IdentityRoleStore>, ILookupNormalizer, IdentityErrorDescriber)

Declaration
public IdentityUserStore(IIdentityUserRepository userRepository, IIdentityRoleRepository roleRepository, IGuidGenerator guidGenerator, ILogger<IdentityRoleStore> logger, ILookupNormalizer lookupNormalizer, IdentityErrorDescriber describer = null)
Parameters
Type Name Description
IIdentityUserRepository userRepository
IIdentityRoleRepository roleRepository
IGuidGenerator guidGenerator
ILogger<IdentityRoleStore> logger
ILookupNormalizer lookupNormalizer
IdentityErrorDescriber describer

Properties

AutoSaveChanges

Declaration
public bool AutoSaveChanges { get; set; }
Property Value
Type Description
bool

ErrorDescriber

Declaration
public IdentityErrorDescriber ErrorDescriber { get; set; }
Property Value
Type Description
IdentityErrorDescriber

GuidGenerator

Declaration
protected IGuidGenerator GuidGenerator { get; }
Property Value
Type Description
IGuidGenerator

Logger

Declaration
protected ILogger<IdentityRoleStore> Logger { get; }
Property Value
Type Description
ILogger<IdentityRoleStore>

LookupNormalizer

Declaration
protected ILookupNormalizer LookupNormalizer { get; }
Property Value
Type Description
ILookupNormalizer

RoleRepository

Declaration
protected IIdentityRoleRepository RoleRepository { get; }
Property Value
Type Description
IIdentityRoleRepository

UserRepository

Declaration
protected IIdentityUserRepository UserRepository { get; }
Property Value
Type Description
IIdentityUserRepository

Methods

AddClaimsAsync(IdentityUser, IEnumerable<Claim>, CancellationToken)

Declaration
public virtual Task AddClaimsAsync(IdentityUser user, IEnumerable<Claim> claims, CancellationToken cancellationToken = default)
Parameters
Type Name Description
IdentityUser user
IEnumerable<Claim> claims
CancellationToken cancellationToken
Returns
Type Description
Task

AddLoginAsync(IdentityUser, UserLoginInfo, CancellationToken)

Declaration
public virtual Task AddLoginAsync(IdentityUser user, UserLoginInfo login, CancellationToken cancellationToken = default)
Parameters
Type Name Description
IdentityUser user
UserLoginInfo login
CancellationToken cancellationToken
Returns
Type Description
Task

AddToRoleAsync(IdentityUser, string, CancellationToken)

Declaration
public virtual Task AddToRoleAsync(IdentityUser user, string normalizedRoleName, CancellationToken cancellationToken = default)
Parameters
Type Name Description
IdentityUser user
string normalizedRoleName
CancellationToken cancellationToken
Returns
Type Description
Task

CountCodesAsync(IdentityUser, CancellationToken)

Declaration
public virtual Task<int> CountCodesAsync(IdentityUser user, CancellationToken cancellationToken = default)
Parameters
Type Name Description
IdentityUser user
CancellationToken cancellationToken
Returns
Type Description
Task<int>

CreateAsync(IdentityUser, CancellationToken)

Declaration
public virtual Task<IdentityResult> CreateAsync(IdentityUser user, CancellationToken cancellationToken = default)
Parameters
Type Name Description
IdentityUser user
CancellationToken cancellationToken
Returns
Type Description
Task<IdentityResult>

DeleteAsync(IdentityUser, CancellationToken)

Declaration
public virtual Task<IdentityResult> DeleteAsync(IdentityUser user, CancellationToken cancellationToken = default)
Parameters
Type Name Description
IdentityUser user
CancellationToken cancellationToken
Returns
Type Description
Task<IdentityResult>

Dispose()

Declaration
public virtual void Dispose()

FindByEmailAsync(string, CancellationToken)

Declaration
public virtual Task<IdentityUser> FindByEmailAsync(string normalizedEmail, CancellationToken cancellationToken = default)
Parameters
Type Name Description
string normalizedEmail
CancellationToken cancellationToken
Returns
Type Description
Task<IdentityUser>

FindByIdAsync(string, CancellationToken)

Declaration
public virtual Task<IdentityUser> FindByIdAsync(string userId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
string userId
CancellationToken cancellationToken
Returns
Type Description
Task<IdentityUser>

FindByLoginAsync(string, string, CancellationToken)

Declaration
public virtual Task<IdentityUser> FindByLoginAsync(string loginProvider, string providerKey, CancellationToken cancellationToken = default)
Parameters
Type Name Description
string loginProvider
string providerKey
CancellationToken cancellationToken
Returns
Type Description
Task<IdentityUser>

FindByNameAsync(string, CancellationToken)

Declaration
public virtual Task<IdentityUser> FindByNameAsync(string normalizedUserName, CancellationToken cancellationToken = default)
Parameters
Type Name Description
string normalizedUserName
CancellationToken cancellationToken
Returns
Type Description
Task<IdentityUser>

GetAccessFailedCountAsync(IdentityUser, CancellationToken)

Declaration
public virtual Task<int> GetAccessFailedCountAsync(IdentityUser user, CancellationToken cancellationToken = default)
Parameters
Type Name Description
IdentityUser user
CancellationToken cancellationToken
Returns
Type Description
Task<int>

GetAuthenticatorKeyAsync(IdentityUser, CancellationToken)

Declaration
public virtual Task<string> GetAuthenticatorKeyAsync(IdentityUser user, CancellationToken cancellationToken = default)
Parameters
Type Name Description
IdentityUser user
CancellationToken cancellationToken
Returns
Type Description
Task<string>

GetAuthenticatorKeyTokenNameAsync()

Declaration
public virtual Task<string> GetAuthenticatorKeyTokenNameAsync()
Returns
Type Description
Task<string>

GetClaimsAsync(IdentityUser, CancellationToken)

Declaration
public virtual Task<IList<Claim>> GetClaimsAsync(IdentityUser user, CancellationToken cancellationToken = default)
Parameters
Type Name Description
IdentityUser user
CancellationToken cancellationToken
Returns
Type Description
Task<IList<Claim>>

GetEmailAsync(IdentityUser, CancellationToken)

Declaration
public virtual Task<string> GetEmailAsync(IdentityUser user, CancellationToken cancellationToken = default)
Parameters
Type Name Description
IdentityUser user
CancellationToken cancellationToken
Returns
Type Description
Task<string>

GetEmailConfirmedAsync(IdentityUser, CancellationToken)

Declaration
public virtual Task<bool> GetEmailConfirmedAsync(IdentityUser user, CancellationToken cancellationToken = default)
Parameters
Type Name Description
IdentityUser user
CancellationToken cancellationToken
Returns
Type Description
Task<bool>

GetInternalLoginProviderAsync()

Declaration
public virtual Task<string> GetInternalLoginProviderAsync()
Returns
Type Description
Task<string>

GetLockoutEnabledAsync(IdentityUser, CancellationToken)

Declaration
public virtual Task<bool> GetLockoutEnabledAsync(IdentityUser user, CancellationToken cancellationToken = default)
Parameters
Type Name Description
IdentityUser user
CancellationToken cancellationToken
Returns
Type Description
Task<bool>

GetLockoutEndDateAsync(IdentityUser, CancellationToken)

Declaration
public virtual Task<DateTimeOffset?> GetLockoutEndDateAsync(IdentityUser user, CancellationToken cancellationToken = default)
Parameters
Type Name Description
IdentityUser user
CancellationToken cancellationToken
Returns
Type Description
Task<DateTimeOffset?>

GetLoginsAsync(IdentityUser, CancellationToken)

Declaration
public virtual Task<IList<UserLoginInfo>> GetLoginsAsync(IdentityUser user, CancellationToken cancellationToken = default)
Parameters
Type Name Description
IdentityUser user
CancellationToken cancellationToken
Returns
Type Description
Task<IList<UserLoginInfo>>

GetNormalizedEmailAsync(IdentityUser, CancellationToken)

Declaration
public virtual Task<string> GetNormalizedEmailAsync(IdentityUser user, CancellationToken cancellationToken = default)
Parameters
Type Name Description
IdentityUser user
CancellationToken cancellationToken
Returns
Type Description
Task<string>

GetNormalizedUserNameAsync(IdentityUser, CancellationToken)

Declaration
public virtual Task<string> GetNormalizedUserNameAsync(IdentityUser user, CancellationToken cancellationToken = default)
Parameters
Type Name Description
IdentityUser user
CancellationToken cancellationToken
Returns
Type Description
Task<string>

GetPasswordHashAsync(IdentityUser, CancellationToken)

Declaration
public virtual Task<string> GetPasswordHashAsync(IdentityUser user, CancellationToken cancellationToken = default)
Parameters
Type Name Description
IdentityUser user
CancellationToken cancellationToken
Returns
Type Description
Task<string>

GetPhoneNumberAsync(IdentityUser, CancellationToken)

Declaration
public virtual Task<string> GetPhoneNumberAsync(IdentityUser user, CancellationToken cancellationToken = default)
Parameters
Type Name Description
IdentityUser user
CancellationToken cancellationToken
Returns
Type Description
Task<string>

GetPhoneNumberConfirmedAsync(IdentityUser, CancellationToken)

Declaration
public virtual Task<bool> GetPhoneNumberConfirmedAsync(IdentityUser user, CancellationToken cancellationToken = default)
Parameters
Type Name Description
IdentityUser user
CancellationToken cancellationToken
Returns
Type Description
Task<bool>

GetRecoveryCodeTokenNameAsync()

Declaration
public virtual Task<string> GetRecoveryCodeTokenNameAsync()
Returns
Type Description
Task<string>

GetRolesAsync(IdentityUser, CancellationToken)

Declaration
public virtual Task<IList<string>> GetRolesAsync(IdentityUser user, CancellationToken cancellationToken = default)
Parameters
Type Name Description
IdentityUser user
CancellationToken cancellationToken
Returns
Type Description
Task<IList<string>>

GetSecurityStampAsync(IdentityUser, CancellationToken)

Declaration
public virtual Task<string> GetSecurityStampAsync(IdentityUser user, CancellationToken cancellationToken = default)
Parameters
Type Name Description
IdentityUser user
CancellationToken cancellationToken
Returns
Type Description
Task<string>

GetTokenAsync(IdentityUser, string, string, CancellationToken)

Declaration
public virtual Task<string> GetTokenAsync(IdentityUser user, string loginProvider, string name, CancellationToken cancellationToken = default)
Parameters
Type Name Description
IdentityUser user
string loginProvider
string name
CancellationToken cancellationToken
Returns
Type Description
Task<string>

GetTwoFactorEnabledAsync(IdentityUser, CancellationToken)

Declaration
public virtual Task<bool> GetTwoFactorEnabledAsync(IdentityUser user, CancellationToken cancellationToken = default)
Parameters
Type Name Description
IdentityUser user
CancellationToken cancellationToken
Returns
Type Description
Task<bool>

GetUserIdAsync(IdentityUser, CancellationToken)

Declaration
public virtual Task<string> GetUserIdAsync(IdentityUser user, CancellationToken cancellationToken = default)
Parameters
Type Name Description
IdentityUser user
CancellationToken cancellationToken
Returns
Type Description
Task<string>

GetUserNameAsync(IdentityUser, CancellationToken)

Declaration
public virtual Task<string> GetUserNameAsync(IdentityUser user, CancellationToken cancellationToken = default)
Parameters
Type Name Description
IdentityUser user
CancellationToken cancellationToken
Returns
Type Description
Task<string>

GetUsersForClaimAsync(Claim, CancellationToken)

Declaration
public virtual Task<IList<IdentityUser>> GetUsersForClaimAsync(Claim claim, CancellationToken cancellationToken = default)
Parameters
Type Name Description
Claim claim
CancellationToken cancellationToken
Returns
Type Description
Task<IList<IdentityUser>>

GetUsersInRoleAsync(string, CancellationToken)

Declaration
public virtual Task<IList<IdentityUser>> GetUsersInRoleAsync(string normalizedRoleName, CancellationToken cancellationToken = default)
Parameters
Type Name Description
string normalizedRoleName
CancellationToken cancellationToken
Returns
Type Description
Task<IList<IdentityUser>>

HasPasswordAsync(IdentityUser, CancellationToken)

Declaration
public virtual Task<bool> HasPasswordAsync(IdentityUser user, CancellationToken cancellationToken = default)
Parameters
Type Name Description
IdentityUser user
CancellationToken cancellationToken
Returns
Type Description
Task<bool>

IncrementAccessFailedCountAsync(IdentityUser, CancellationToken)

Declaration
public virtual Task<int> IncrementAccessFailedCountAsync(IdentityUser user, CancellationToken cancellationToken = default)
Parameters
Type Name Description
IdentityUser user
CancellationToken cancellationToken
Returns
Type Description
Task<int>

IsInRoleAsync(IdentityUser, string, CancellationToken)

Declaration
public virtual Task<bool> IsInRoleAsync(IdentityUser user, string normalizedRoleName, CancellationToken cancellationToken = default)
Parameters
Type Name Description
IdentityUser user
string normalizedRoleName
CancellationToken cancellationToken
Returns
Type Description
Task<bool>

RedeemCodeAsync(IdentityUser, string, CancellationToken)

Declaration
public virtual Task<bool> RedeemCodeAsync(IdentityUser user, string code, CancellationToken cancellationToken = default)
Parameters
Type Name Description
IdentityUser user
string code
CancellationToken cancellationToken
Returns
Type Description
Task<bool>

RemoveClaimsAsync(IdentityUser, IEnumerable<Claim>, CancellationToken)

Declaration
public virtual Task RemoveClaimsAsync(IdentityUser user, IEnumerable<Claim> claims, CancellationToken cancellationToken = default)
Parameters
Type Name Description
IdentityUser user
IEnumerable<Claim> claims
CancellationToken cancellationToken
Returns
Type Description
Task

RemoveFromRoleAsync(IdentityUser, string, CancellationToken)

Declaration
public virtual Task RemoveFromRoleAsync(IdentityUser user, string normalizedRoleName, CancellationToken cancellationToken = default)
Parameters
Type Name Description
IdentityUser user
string normalizedRoleName
CancellationToken cancellationToken
Returns
Type Description
Task

RemoveLoginAsync(IdentityUser, string, string, CancellationToken)

Declaration
public virtual Task RemoveLoginAsync(IdentityUser user, string loginProvider, string providerKey, CancellationToken cancellationToken = default)
Parameters
Type Name Description
IdentityUser user
string loginProvider
string providerKey
CancellationToken cancellationToken
Returns
Type Description
Task

RemoveTokenAsync(IdentityUser, string, string, CancellationToken)

Declaration
public virtual Task RemoveTokenAsync(IdentityUser user, string loginProvider, string name, CancellationToken cancellationToken = default)
Parameters
Type Name Description
IdentityUser user
string loginProvider
string name
CancellationToken cancellationToken
Returns
Type Description
Task

ReplaceClaimAsync(IdentityUser, Claim, Claim, CancellationToken)

Declaration
public virtual Task ReplaceClaimAsync(IdentityUser user, Claim claim, Claim newClaim, CancellationToken cancellationToken = default)
Parameters
Type Name Description
IdentityUser user
Claim claim
Claim newClaim
CancellationToken cancellationToken
Returns
Type Description
Task

ReplaceCodesAsync(IdentityUser, IEnumerable<string>, CancellationToken)

Declaration
public virtual Task ReplaceCodesAsync(IdentityUser user, IEnumerable<string> recoveryCodes, CancellationToken cancellationToken = default)
Parameters
Type Name Description
IdentityUser user
IEnumerable<string> recoveryCodes
CancellationToken cancellationToken
Returns
Type Description
Task

ResetAccessFailedCountAsync(IdentityUser, CancellationToken)

Declaration
public virtual Task ResetAccessFailedCountAsync(IdentityUser user, CancellationToken cancellationToken = default)
Parameters
Type Name Description
IdentityUser user
CancellationToken cancellationToken
Returns
Type Description
Task

SetAuthenticatorKeyAsync(IdentityUser, string, CancellationToken)

Declaration
public virtual Task SetAuthenticatorKeyAsync(IdentityUser user, string key, CancellationToken cancellationToken = default)
Parameters
Type Name Description
IdentityUser user
string key
CancellationToken cancellationToken
Returns
Type Description
Task

SetEmailAsync(IdentityUser, string, CancellationToken)

Declaration
public virtual Task SetEmailAsync(IdentityUser user, string email, CancellationToken cancellationToken = default)
Parameters
Type Name Description
IdentityUser user
string email
CancellationToken cancellationToken
Returns
Type Description
Task

SetEmailConfirmedAsync(IdentityUser, bool, CancellationToken)

Declaration
public virtual Task SetEmailConfirmedAsync(IdentityUser user, bool confirmed, CancellationToken cancellationToken = default)
Parameters
Type Name Description
IdentityUser user
bool confirmed
CancellationToken cancellationToken
Returns
Type Description
Task

SetLockoutEnabledAsync(IdentityUser, bool, CancellationToken)

Declaration
public virtual Task SetLockoutEnabledAsync(IdentityUser user, bool enabled, CancellationToken cancellationToken = default)
Parameters
Type Name Description
IdentityUser user
bool enabled
CancellationToken cancellationToken
Returns
Type Description
Task

SetLockoutEndDateAsync(IdentityUser, DateTimeOffset?, CancellationToken)

Declaration
public virtual Task SetLockoutEndDateAsync(IdentityUser user, DateTimeOffset? lockoutEnd, CancellationToken cancellationToken = default)
Parameters
Type Name Description
IdentityUser user
DateTimeOffset? lockoutEnd
CancellationToken cancellationToken
Returns
Type Description
Task

SetNormalizedEmailAsync(IdentityUser, string, CancellationToken)

Declaration
public virtual Task SetNormalizedEmailAsync(IdentityUser user, string normalizedEmail, CancellationToken cancellationToken = default)
Parameters
Type Name Description
IdentityUser user
string normalizedEmail
CancellationToken cancellationToken
Returns
Type Description
Task

SetNormalizedUserNameAsync(IdentityUser, string, CancellationToken)

Declaration
public virtual Task SetNormalizedUserNameAsync(IdentityUser user, string normalizedName, CancellationToken cancellationToken = default)
Parameters
Type Name Description
IdentityUser user
string normalizedName
CancellationToken cancellationToken
Returns
Type Description
Task

SetPasswordHashAsync(IdentityUser, string, CancellationToken)

Declaration
public virtual Task SetPasswordHashAsync(IdentityUser user, string passwordHash, CancellationToken cancellationToken = default)
Parameters
Type Name Description
IdentityUser user
string passwordHash
CancellationToken cancellationToken
Returns
Type Description
Task

SetPhoneNumberAsync(IdentityUser, string, CancellationToken)

Declaration
public virtual Task SetPhoneNumberAsync(IdentityUser user, string phoneNumber, CancellationToken cancellationToken = default)
Parameters
Type Name Description
IdentityUser user
string phoneNumber
CancellationToken cancellationToken
Returns
Type Description
Task

SetPhoneNumberConfirmedAsync(IdentityUser, bool, CancellationToken)

Declaration
public virtual Task SetPhoneNumberConfirmedAsync(IdentityUser user, bool confirmed, CancellationToken cancellationToken = default)
Parameters
Type Name Description
IdentityUser user
bool confirmed
CancellationToken cancellationToken
Returns
Type Description
Task

SetSecurityStampAsync(IdentityUser, string, CancellationToken)

Declaration
public virtual Task SetSecurityStampAsync(IdentityUser user, string stamp, CancellationToken cancellationToken = default)
Parameters
Type Name Description
IdentityUser user
string stamp
CancellationToken cancellationToken
Returns
Type Description
Task

SetTokenAsync(IdentityUser, string, string, string, CancellationToken)

Declaration
public virtual Task SetTokenAsync(IdentityUser user, string loginProvider, string name, string value, CancellationToken cancellationToken = default)
Parameters
Type Name Description
IdentityUser user
string loginProvider
string name
string value
CancellationToken cancellationToken
Returns
Type Description
Task

SetTwoFactorEnabledAsync(IdentityUser, bool, CancellationToken)

Declaration
public virtual Task SetTwoFactorEnabledAsync(IdentityUser user, bool enabled, CancellationToken cancellationToken = default)
Parameters
Type Name Description
IdentityUser user
bool enabled
CancellationToken cancellationToken
Returns
Type Description
Task

SetUserNameAsync(IdentityUser, string, CancellationToken)

Declaration
public virtual Task SetUserNameAsync(IdentityUser user, string userName, CancellationToken cancellationToken = default)
Parameters
Type Name Description
IdentityUser user
string userName
CancellationToken cancellationToken
Returns
Type Description
Task

UpdateAsync(IdentityUser, CancellationToken)

Declaration
public virtual Task<IdentityResult> UpdateAsync(IdentityUser user, CancellationToken cancellationToken = default)
Parameters
Type Name Description
IdentityUser user
CancellationToken cancellationToken
Returns
Type Description
Task<IdentityResult>

Implements

IUserLoginStore<TUser>
IUserRoleStore<TUser>
IUserClaimStore<TUser>
IUserPasswordStore<TUser>
IUserSecurityStampStore<TUser>
IUserEmailStore<TUser>
IUserLockoutStore<TUser>
IUserPhoneNumberStore<TUser>
IUserTwoFactorStore<TUser>
IUserAuthenticationTokenStore<TUser>
IUserAuthenticatorKeyStore<TUser>
IUserTwoFactorRecoveryCodeStore<TUser>
IUserStore<TUser>
IDisposable
ITransientDependency

Extension Methods

AbpObjectExtensions.As<T>(object)
AbpObjectExtensions.To<T>(object)
LockExtensions.Locking(object, Action)
LockExtensions.Locking<TResult>(object, Func<TResult>)
AbpObjectExtensions.If<T>(T, bool, Action<T>)
AbpObjectExtensions.If<T>(T, bool, Func<T, T>)
AbpObjectExtensions.IsIn<T>(T, IEnumerable<T>)
AbpObjectExtensions.IsIn<T>(T, params T[])
AbpQueryableExtensions.OrderByIf<T, TQueryable>(TQueryable, bool, string)
AbpQueryableExtensions.PageBy<T, TQueryable>(TQueryable, int, int)
AbpQueryableExtensions.WhereIf<T, TQueryable>(TQueryable, bool, Expression<Func<T, bool>>)
AbpQueryableExtensions.WhereIf<T, TQueryable>(TQueryable, bool, Expression<Func<T, int, bool>>)
AbpOpenIddictQueryableExtensions.SkipIf<T, TQueryable>(TQueryable, bool, int?)
AbpOpenIddictQueryableExtensions.TakeIf<T, TQueryable>(TQueryable, bool, int?)
LockExtensions.Locking<T>(T, Action<T>)
LockExtensions.Locking<T, TResult>(T, Func<T, TResult>)
In this article
Back to top Powered by ABP.IO Platform