UserManager<TUser> UserManager<TUser> UserManager<TUser> Class

Definition

Provides the APIs for managing user in a persistence store.

public class UserManager<TUser> : IDisposable where TUser : class
type UserManager<'User (requires 'User : null)> = class
    interface IDisposable
Public Class UserManager(Of TUser)
Implements IDisposable
Type Parameters
TUser

The type encapsulating a user.

Inheritance
UserManager<TUser>UserManager<TUser>UserManager<TUser>
Derived
Implements

Constructors

UserManager<TUser>(IUserStore<TUser>, IOptions<IdentityOptions>, IPasswordHasher<TUser>, IEnumerable<IUserValidator<TUser>>, IEnumerable<IPasswordValidator<TUser>>, ILookupNormalizer, IdentityErrorDescriber, IServiceProvider, ILogger<UserManager<TUser>>) UserManager<TUser>(IUserStore<TUser>, IOptions<IdentityOptions>, IPasswordHasher<TUser>, IEnumerable<IUserValidator<TUser>>, IEnumerable<IPasswordValidator<TUser>>, ILookupNormalizer, IdentityErrorDescriber, IServiceProvider, ILogger<UserManager<TUser>>) UserManager<TUser>(IUserStore<TUser>, IOptions<IdentityOptions>, IPasswordHasher<TUser>, IEnumerable<IUserValidator<TUser>>, IEnumerable<IPasswordValidator<TUser>>, ILookupNormalizer, IdentityErrorDescriber, IServiceProvider, ILogger<UserManager<TUser>>)

Constructs a new instance of UserManager<TUser>.

UserManager<TUser>(IUserStore<TUser>, IOptions<IdentityOptions>, IPasswordHasher<TUser>, IEnumerable<IUserValidator<TUser>>, IEnumerable<IPasswordValidator<TUser>>, ILookupNormalizer, IdentityErrorDescriber, IServiceProvider, ILogger<UserManager<TUser>>) UserManager<TUser>(IUserStore<TUser>, IOptions<IdentityOptions>, IPasswordHasher<TUser>, IEnumerable<IUserValidator<TUser>>, IEnumerable<IPasswordValidator<TUser>>, ILookupNormalizer, IdentityErrorDescriber, IServiceProvider, ILogger<UserManager<TUser>>) UserManager<TUser>(IUserStore<TUser>, IOptions<IdentityOptions>, IPasswordHasher<TUser>, IEnumerable<IUserValidator<TUser>>, IEnumerable<IPasswordValidator<TUser>>, ILookupNormalizer, IdentityErrorDescriber, IServiceProvider, ILogger<UserManager<TUser>>)

Constructs a new instance of UserManager<TUser>.

Fields

ChangePhoneNumberTokenPurpose ChangePhoneNumberTokenPurpose ChangePhoneNumberTokenPurpose

The data protection purpose used for the change phone number methods.

ConfirmEmailTokenPurpose ConfirmEmailTokenPurpose ConfirmEmailTokenPurpose

The data protection purpose used for the email confirmation related methods.

ResetPasswordTokenPurpose ResetPasswordTokenPurpose ResetPasswordTokenPurpose

The data protection purpose used for the reset password related methods.

Properties

CancellationToken CancellationToken CancellationToken

The cancellation token used to cancel operations.

ErrorDescriber ErrorDescriber ErrorDescriber

The IdentityErrorDescriber used to generate error messages.

KeyNormalizer KeyNormalizer KeyNormalizer

The ILookupNormalizer used to normalize things like user and role names.

Logger Logger Logger

The ILogger used to log messages from the manager.

Options Options Options

The IdentityOptions used to configure Identity.

PasswordHasher PasswordHasher PasswordHasher

The IPasswordHasher<TUser> used to hash passwords.

PasswordValidators PasswordValidators PasswordValidators

The IPasswordValidator<TUser> used to validate passwords.

Store Store Store

Gets or sets the persistence store the manager operates over.

SupportsQueryableUsers SupportsQueryableUsers SupportsQueryableUsers

Gets a flag indicating whether the backing user store supports returning IQueryable collections of information.

SupportsUserAuthenticationTokens SupportsUserAuthenticationTokens SupportsUserAuthenticationTokens

Gets a flag indicating whether the backing user store supports authentication tokens.

SupportsUserAuthenticatorKey SupportsUserAuthenticatorKey SupportsUserAuthenticatorKey

Gets a flag indicating whether the backing user store supports a user authenticator.

SupportsUserClaim SupportsUserClaim SupportsUserClaim

Gets a flag indicating whether the backing user store supports user claims.

SupportsUserEmail SupportsUserEmail SupportsUserEmail

Gets a flag indicating whether the backing user store supports user emails.

SupportsUserLockout SupportsUserLockout SupportsUserLockout

Gets a flag indicating whether the backing user store supports user lock-outs.

SupportsUserLogin SupportsUserLogin SupportsUserLogin

Gets a flag indicating whether the backing user store supports external logins.

SupportsUserPassword SupportsUserPassword SupportsUserPassword

Gets a flag indicating whether the backing user store supports user passwords.

SupportsUserPhoneNumber SupportsUserPhoneNumber SupportsUserPhoneNumber

Gets a flag indicating whether the backing user store supports user telephone numbers.

SupportsUserRole SupportsUserRole SupportsUserRole

Gets a flag indicating whether the backing user store supports user roles.

SupportsUserSecurityStamp SupportsUserSecurityStamp SupportsUserSecurityStamp

Gets a flag indicating whether the backing user store supports security stamps.

SupportsUserTwoFactor SupportsUserTwoFactor SupportsUserTwoFactor

Gets a flag indicating whether the backing user store supports two factor authentication.

SupportsUserTwoFactorRecoveryCodes SupportsUserTwoFactorRecoveryCodes SupportsUserTwoFactorRecoveryCodes

Gets a flag indicating whether the backing user store supports recovery codes.

Users Users Users

Returns an IQueryable of users if the store is an IQueryableUserStore

UserValidators UserValidators UserValidators

The IUserValidator<TUser> used to validate users.

Methods

AccessFailedAsync(TUser) AccessFailedAsync(TUser) AccessFailedAsync(TUser)

Increments the access failed count for the user as an asynchronous operation. If the failed access account is greater than or equal to the configured maximum number of attempts, the user will be locked out for the configured lockout time span.

AddClaimAsync(TUser, Claim) AddClaimAsync(TUser, Claim) AddClaimAsync(TUser, Claim)

Adds the specified claim to the user.

AddClaimsAsync(TUser, IEnumerable<Claim>) AddClaimsAsync(TUser, IEnumerable<Claim>) AddClaimsAsync(TUser, IEnumerable<Claim>)

Adds the specified claims to the user.

AddLoginAsync(TUser, UserLoginInfo) AddLoginAsync(TUser, UserLoginInfo) AddLoginAsync(TUser, UserLoginInfo)

Adds an external UserLoginInfo to the specified user.

AddPasswordAsync(TUser, String) AddPasswordAsync(TUser, String) AddPasswordAsync(TUser, String)

Adds the password to the specified user only if the user does not already have a password.

AddToRoleAsync(TUser, String) AddToRoleAsync(TUser, String) AddToRoleAsync(TUser, String)

Add the specified user to the named role.

AddToRolesAsync(TUser, IEnumerable<String>) AddToRolesAsync(TUser, IEnumerable<String>) AddToRolesAsync(TUser, IEnumerable<String>)

Add the specified user to the named roles.

ChangeEmailAsync(TUser, String, String) ChangeEmailAsync(TUser, String, String) ChangeEmailAsync(TUser, String, String)

Updates a users emails if the specified email change token is valid for the user.

ChangePasswordAsync(TUser, String, String) ChangePasswordAsync(TUser, String, String) ChangePasswordAsync(TUser, String, String)

Changes a user's password after confirming the specified currentPassword is correct, as an asynchronous operation.

ChangePhoneNumberAsync(TUser, String, String) ChangePhoneNumberAsync(TUser, String, String) ChangePhoneNumberAsync(TUser, String, String)

Sets the phone number for the specified user if the specified change token is valid.

CheckPasswordAsync(TUser, String) CheckPasswordAsync(TUser, String) CheckPasswordAsync(TUser, String)

Returns a flag indicating whether the given password is valid for the specified user.

ConfirmEmailAsync(TUser, String) ConfirmEmailAsync(TUser, String) ConfirmEmailAsync(TUser, String)

Validates that an email confirmation token matches the specified user.

CountRecoveryCodesAsync(TUser) CountRecoveryCodesAsync(TUser) CountRecoveryCodesAsync(TUser)

Returns how many recovery code are still valid for a user.

CreateAsync(TUser) CreateAsync(TUser) CreateAsync(TUser)

Creates the specified user in the backing store with no password, as an asynchronous operation.

CreateAsync(TUser, String) CreateAsync(TUser, String) CreateAsync(TUser, String)

Creates the specified user in the backing store with given password, as an asynchronous operation.

CreateSecurityTokenAsync(TUser) CreateSecurityTokenAsync(TUser) CreateSecurityTokenAsync(TUser)

Creates bytes to use as a security token from the user's security stamp.

CreateTwoFactorRecoveryCode() CreateTwoFactorRecoveryCode() CreateTwoFactorRecoveryCode()

Generate a new recovery code.

DeleteAsync(TUser) DeleteAsync(TUser) DeleteAsync(TUser)

Deletes the specified user from the backing store.

Dispose() Dispose() Dispose()

Releases all resources used by the user manager.

Dispose(Boolean) Dispose(Boolean) Dispose(Boolean)

Releases the unmanaged resources used by the role manager and optionally releases the managed resources.

FindByEmailAsync(String) FindByEmailAsync(String) FindByEmailAsync(String)

Gets the user, if any, associated with the normalized value of the specified email address.

FindByIdAsync(String) FindByIdAsync(String) FindByIdAsync(String)

Finds and returns a user, if any, who has the specified userId.

FindByLoginAsync(String, String) FindByLoginAsync(String, String) FindByLoginAsync(String, String)

Retrieves the user associated with the specified external login provider and login provider key.

FindByNameAsync(String) FindByNameAsync(String) FindByNameAsync(String)

Finds and returns a user, if any, who has the specified user name.

GenerateChangeEmailTokenAsync(TUser, String) GenerateChangeEmailTokenAsync(TUser, String) GenerateChangeEmailTokenAsync(TUser, String)

Generates an email change token for the specified user.

GenerateChangePhoneNumberTokenAsync(TUser, String) GenerateChangePhoneNumberTokenAsync(TUser, String) GenerateChangePhoneNumberTokenAsync(TUser, String)

Generates a telephone number change token for the specified user.

GenerateConcurrencyStampAsync(TUser) GenerateConcurrencyStampAsync(TUser) GenerateConcurrencyStampAsync(TUser)

Generates a value suitable for use in concurrency tracking.

GenerateEmailConfirmationTokenAsync(TUser) GenerateEmailConfirmationTokenAsync(TUser) GenerateEmailConfirmationTokenAsync(TUser)

Generates an email confirmation token for the specified user.

GenerateNewAuthenticatorKey() GenerateNewAuthenticatorKey() GenerateNewAuthenticatorKey()

Generates a new base32 encoded 160-bit security secret (size of SHA1 hash).

GenerateNewTwoFactorRecoveryCodesAsync(TUser, Int32) GenerateNewTwoFactorRecoveryCodesAsync(TUser, Int32) GenerateNewTwoFactorRecoveryCodesAsync(TUser, Int32)

Generates recovery codes for the user, this invalidates any previous recovery codes for the user.

GeneratePasswordResetTokenAsync(TUser) GeneratePasswordResetTokenAsync(TUser) GeneratePasswordResetTokenAsync(TUser)

Generates a password reset token for the specified user, using the configured password reset token provider.

GenerateTwoFactorTokenAsync(TUser, String) GenerateTwoFactorTokenAsync(TUser, String) GenerateTwoFactorTokenAsync(TUser, String)

Gets a two factor authentication token for the specified user.

GenerateUserTokenAsync(TUser, String, String) GenerateUserTokenAsync(TUser, String, String) GenerateUserTokenAsync(TUser, String, String)

Generates a token for the given user and purpose.

GetAccessFailedCountAsync(TUser) GetAccessFailedCountAsync(TUser) GetAccessFailedCountAsync(TUser)

Retrieves the current number of failed accesses for the given user.

GetAuthenticationTokenAsync(TUser, String, String) GetAuthenticationTokenAsync(TUser, String, String) GetAuthenticationTokenAsync(TUser, String, String)

Returns an authentication token for a user.

GetAuthenticatorKeyAsync(TUser) GetAuthenticatorKeyAsync(TUser) GetAuthenticatorKeyAsync(TUser)

Returns the authenticator key for the user.

GetChangeEmailTokenPurpose(String) GetChangeEmailTokenPurpose(String) GetChangeEmailTokenPurpose(String)

Generates the token purpose used to change email.

GetClaimsAsync(TUser) GetClaimsAsync(TUser) GetClaimsAsync(TUser)

Gets a list of Claims to be belonging to the specified user as an asynchronous operation.

GetEmailAsync(TUser) GetEmailAsync(TUser) GetEmailAsync(TUser)

Gets the email address for the specified user.

GetLockoutEnabledAsync(TUser) GetLockoutEnabledAsync(TUser) GetLockoutEnabledAsync(TUser)

Retrieves a flag indicating whether user lockout can enabled for the specified user.

GetLockoutEndDateAsync(TUser) GetLockoutEndDateAsync(TUser) GetLockoutEndDateAsync(TUser)

Gets the last DateTimeOffset a user's last lockout expired, if any. Any time in the past should be indicates a user is not locked out.

GetLoginsAsync(TUser) GetLoginsAsync(TUser) GetLoginsAsync(TUser)

Retrieves the associated logins for the specified .

GetPhoneNumberAsync(TUser) GetPhoneNumberAsync(TUser) GetPhoneNumberAsync(TUser)

Gets the telephone number, if any, for the specified user.

GetRolesAsync(TUser) GetRolesAsync(TUser) GetRolesAsync(TUser)

Gets a list of role names the specified user belongs to.

GetSecurityStampAsync(TUser) GetSecurityStampAsync(TUser) GetSecurityStampAsync(TUser)

Get the security stamp for the specified user.

GetTwoFactorEnabledAsync(TUser) GetTwoFactorEnabledAsync(TUser) GetTwoFactorEnabledAsync(TUser)

Returns a flag indicating whether the specified user has two factor authentication enabled or not, as an asynchronous operation.

GetUserAsync(ClaimsPrincipal) GetUserAsync(ClaimsPrincipal) GetUserAsync(ClaimsPrincipal)

Returns the user corresponding to the IdentityOptions.ClaimsIdentity.UserIdClaimType claim in the principal or null.

GetUserId(ClaimsPrincipal) GetUserId(ClaimsPrincipal) GetUserId(ClaimsPrincipal)

Returns the User ID claim value if present otherwise returns null.

GetUserIdAsync(TUser) GetUserIdAsync(TUser) GetUserIdAsync(TUser)

Gets the user identifier for the specified user.

GetUserName(ClaimsPrincipal) GetUserName(ClaimsPrincipal) GetUserName(ClaimsPrincipal)

Returns the Name claim value if present otherwise returns null.

GetUserNameAsync(TUser) GetUserNameAsync(TUser) GetUserNameAsync(TUser)

Gets the user name for the specified user.

GetUsersForClaimAsync(Claim) GetUsersForClaimAsync(Claim) GetUsersForClaimAsync(Claim)

Returns a list of users from the user store who have the specified claim.

GetUsersInRoleAsync(String) GetUsersInRoleAsync(String) GetUsersInRoleAsync(String)

Returns a list of users from the user store who are members of the specified roleName.

GetValidTwoFactorProvidersAsync(TUser) GetValidTwoFactorProvidersAsync(TUser) GetValidTwoFactorProvidersAsync(TUser)

Gets a list of valid two factor token providers for the specified user, as an asynchronous operation.

HasPasswordAsync(TUser) HasPasswordAsync(TUser) HasPasswordAsync(TUser)

Gets a flag indicating whether the specified user has a password.

IsEmailConfirmedAsync(TUser) IsEmailConfirmedAsync(TUser) IsEmailConfirmedAsync(TUser)

Gets a flag indicating whether the email address for the specified user has been verified, true if the email address is verified otherwise false.

IsInRoleAsync(TUser, String) IsInRoleAsync(TUser, String) IsInRoleAsync(TUser, String)

Returns a flag indicating whether the specified user is a member of the give named role.

IsLockedOutAsync(TUser) IsLockedOutAsync(TUser) IsLockedOutAsync(TUser)

Returns a flag indicating whether the specified user his locked out, as an asynchronous operation.

IsPhoneNumberConfirmedAsync(TUser) IsPhoneNumberConfirmedAsync(TUser) IsPhoneNumberConfirmedAsync(TUser)

Gets a flag indicating whether the specified user's telephone number has been confirmed.

NormalizeKey(String) NormalizeKey(String) NormalizeKey(String)

Normalize a key (user name, email) for consistent comparisons.

RedeemTwoFactorRecoveryCodeAsync(TUser, String) RedeemTwoFactorRecoveryCodeAsync(TUser, String) RedeemTwoFactorRecoveryCodeAsync(TUser, String)

Returns whether a recovery code is valid for a user. Note: recovery codes are only valid once, and will be invalid after use.

RegisterTokenProvider(String, IUserTwoFactorTokenProvider<TUser>) RegisterTokenProvider(String, IUserTwoFactorTokenProvider<TUser>) RegisterTokenProvider(String, IUserTwoFactorTokenProvider<TUser>)

Registers a token provider.

RemoveAuthenticationTokenAsync(TUser, String, String) RemoveAuthenticationTokenAsync(TUser, String, String) RemoveAuthenticationTokenAsync(TUser, String, String)

Remove an authentication token for a user.

RemoveClaimAsync(TUser, Claim) RemoveClaimAsync(TUser, Claim) RemoveClaimAsync(TUser, Claim)

Removes the specified claim from the given user.

RemoveClaimsAsync(TUser, IEnumerable<Claim>) RemoveClaimsAsync(TUser, IEnumerable<Claim>) RemoveClaimsAsync(TUser, IEnumerable<Claim>)

Removes the specified claims from the given user.

RemoveFromRoleAsync(TUser, String) RemoveFromRoleAsync(TUser, String) RemoveFromRoleAsync(TUser, String)

Removes the specified user from the named role.

RemoveFromRolesAsync(TUser, IEnumerable<String>) RemoveFromRolesAsync(TUser, IEnumerable<String>) RemoveFromRolesAsync(TUser, IEnumerable<String>)

Removes the specified user from the named roles.

RemoveLoginAsync(TUser, String, String) RemoveLoginAsync(TUser, String, String) RemoveLoginAsync(TUser, String, String)

Attempts to remove the provided external login information from the specified user. and returns a flag indicating whether the removal succeed or not.

RemovePasswordAsync(TUser) RemovePasswordAsync(TUser) RemovePasswordAsync(TUser)

Removes a user's password.

RemovePasswordAsync(TUser, CancellationToken) RemovePasswordAsync(TUser, CancellationToken) RemovePasswordAsync(TUser, CancellationToken)

Removes a user's password.

ReplaceClaimAsync(TUser, Claim, Claim) ReplaceClaimAsync(TUser, Claim, Claim) ReplaceClaimAsync(TUser, Claim, Claim)

Replaces the given claim on the specified user with the newClaim

ResetAccessFailedCountAsync(TUser) ResetAccessFailedCountAsync(TUser) ResetAccessFailedCountAsync(TUser)

Resets the access failed count for the specified user.

ResetAuthenticatorKeyAsync(TUser) ResetAuthenticatorKeyAsync(TUser) ResetAuthenticatorKeyAsync(TUser)

Resets the authenticator key for the user.

ResetPasswordAsync(TUser, String, String) ResetPasswordAsync(TUser, String, String) ResetPasswordAsync(TUser, String, String)

Resets the user's password to the specified newPassword after validating the given password reset token.

SetAuthenticationTokenAsync(TUser, String, String, String) SetAuthenticationTokenAsync(TUser, String, String, String) SetAuthenticationTokenAsync(TUser, String, String, String)

Sets an authentication token for a user.

SetEmailAsync(TUser, String) SetEmailAsync(TUser, String) SetEmailAsync(TUser, String)

Sets the email address for a user.

SetLockoutEnabledAsync(TUser, Boolean) SetLockoutEnabledAsync(TUser, Boolean) SetLockoutEnabledAsync(TUser, Boolean)

Sets a flag indicating whether the specified user is locked out, as an asynchronous operation.

SetLockoutEndDateAsync(TUser, Nullable<DateTimeOffset>) SetLockoutEndDateAsync(TUser, Nullable<DateTimeOffset>) SetLockoutEndDateAsync(TUser, Nullable<DateTimeOffset>)

Locks out a user until the specified end date has passed. Setting a end date in the past immediately unlocks a user.

SetPhoneNumberAsync(TUser, String) SetPhoneNumberAsync(TUser, String) SetPhoneNumberAsync(TUser, String)

Sets the phone number for the specified user.

SetTwoFactorEnabledAsync(TUser, Boolean) SetTwoFactorEnabledAsync(TUser, Boolean) SetTwoFactorEnabledAsync(TUser, Boolean)

Sets a flag indicating whether the specified user has two factor authentication enabled or not, as an asynchronous operation.

SetUserNameAsync(TUser, String) SetUserNameAsync(TUser, String) SetUserNameAsync(TUser, String)

Sets the given userName for the specified user.

ThrowIfDisposed() ThrowIfDisposed() ThrowIfDisposed()

Throws if this class has been disposed.

UpdateAsync(TUser) UpdateAsync(TUser) UpdateAsync(TUser)

Updates the specified user in the backing store.

UpdateNormalizedEmailAsync(TUser) UpdateNormalizedEmailAsync(TUser) UpdateNormalizedEmailAsync(TUser)

Updates the normalized email for the specified user.

UpdateNormalizedUserNameAsync(TUser) UpdateNormalizedUserNameAsync(TUser) UpdateNormalizedUserNameAsync(TUser)

Updates the normalized user name for the specified user.

UpdatePasswordHash(TUser, String, Boolean) UpdatePasswordHash(TUser, String, Boolean) UpdatePasswordHash(TUser, String, Boolean)

Updates a user's password hash.

UpdateSecurityStampAsync(TUser) UpdateSecurityStampAsync(TUser) UpdateSecurityStampAsync(TUser)

Regenerates the security stamp for the specified user.

UpdateUserAsync(TUser) UpdateUserAsync(TUser) UpdateUserAsync(TUser)

Called to update the user after validating and updating the normalized email/user name.

ValidatePasswordAsync(TUser, String) ValidatePasswordAsync(TUser, String) ValidatePasswordAsync(TUser, String)

Should return Success if validation is successful. This is called before updating the password hash.

ValidateUserAsync(TUser) ValidateUserAsync(TUser) ValidateUserAsync(TUser)

Should return Success if validation is successful. This is called before saving the user via Create or Update.

VerifyChangePhoneNumberTokenAsync(TUser, String, String) VerifyChangePhoneNumberTokenAsync(TUser, String, String) VerifyChangePhoneNumberTokenAsync(TUser, String, String)

Returns a flag indicating whether the specified user's phone number change verification token is valid for the given phoneNumber.

VerifyPasswordAsync(IUserPasswordStore<TUser>, TUser, String) VerifyPasswordAsync(IUserPasswordStore<TUser>, TUser, String) VerifyPasswordAsync(IUserPasswordStore<TUser>, TUser, String)

Returns a PasswordVerificationResult indicating the result of a password hash comparison.

VerifyTwoFactorTokenAsync(TUser, String, String) VerifyTwoFactorTokenAsync(TUser, String, String) VerifyTwoFactorTokenAsync(TUser, String, String)

Verifies the specified two factor authentication token against the user.

VerifyUserTokenAsync(TUser, String, String, String) VerifyUserTokenAsync(TUser, String, String, String) VerifyUserTokenAsync(TUser, String, String, String)

Returns a flag indicating whether the specified token is valid for the given user and purpose.

Applies to