UserManager<TUser> 类

定义

提供用于在持久性存储区中管理用户的 API。

generic <typename TUser>
 where TUser : classpublic ref class UserManager : IDisposable
public class UserManager<TUser> : IDisposable where TUser : class
type UserManager<'User (requires 'User : null)> = class
    interface IDisposable
Public Class UserManager(Of TUser)
Implements IDisposable

类型参数

TUser

封装用户的类型。

继承
UserManager<TUser>
派生
实现

构造函数

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

构造 UserManager<TUser> 的新实例。

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

构造 UserManager<TUser> 的新实例。

字段

ChangePhoneNumberTokenPurpose

用于更改电话号码方法的数据保护目的。

ConfirmEmailTokenPurpose

用于电子邮件确认相关方法的数据保护目的。

ResetPasswordTokenPurpose

用于重置密码相关方法的数据保护目的。

属性

CancellationToken

用于取消操作的取消令牌。

ErrorDescriber

IdentityErrorDescriber用于生成错误消息的 。

KeyNormalizer

ILookupNormalizer用于规范化用户和角色名称等内容的 。

Logger

ILogger用于记录来自管理器的消息的 。

Options

IdentityOptions用于配置标识的 。

PasswordHasher

IPasswordHasher<TUser>用于对密码进行哈希运算的 。

PasswordValidators

IPasswordValidator<TUser>用于验证密码的 。

Store

获取或设置管理器操作的持久性存储。

SupportsQueryableUsers

获取一个标志,该标志指示后备用户存储是否支持返回 IQueryable 信息集合。

SupportsUserAuthenticationTokens

获取一个标志,该标志指示后备用户存储是否支持身份验证令牌。

SupportsUserAuthenticatorKey

获取一个标志,该标志指示后备用户存储是否支持用户验证器。

SupportsUserClaim

获取一个标志,该标志指示后备用户存储是否支持用户声明。

SupportsUserEmail

获取一个标志,该标志指示后备用户存储是否支持用户电子邮件。

SupportsUserLockout

获取一个标志,该标志指示后备用户存储是否支持用户锁定。

SupportsUserLogin

获取一个标志,该标志指示后备用户存储是否支持外部登录。

SupportsUserPassword

获取一个标志,该标志指示后备用户存储是否支持用户密码。

SupportsUserPhoneNumber

获取一个标志,该标志指示后备用户存储是否支持用户电话号码。

SupportsUserRole

获取一个标志,该标志指示后备用户存储是否支持用户角色。

SupportsUserSecurityStamp

获取一个标志,该标志指示后备用户存储是否支持安全标记。

SupportsUserTwoFactor

获取一个标志,该标志指示后备用户存储是否支持双因素身份验证。

SupportsUserTwoFactorRecoveryCodes

获取一个标志,该标志指示后备用户存储是否支持恢复代码。

Users

如果存储是 IQueryableUserStore,则返回用户的 IQueryable

UserValidators

IUserValidator<TUser>用于验证用户的 。

方法

AccessFailedAsync(TUser)

将用户的访问失败计数作为异步操作递增。 如果失败的访问帐户大于或等于配置的最大尝试次数,则会在配置的锁定时间跨度内锁定用户。

AddClaimAsync(TUser, Claim)

将指定的 claim 添加到 user

AddClaimsAsync(TUser, IEnumerable<Claim>)

将指定的 claims 添加到 user

AddLoginAsync(TUser, UserLoginInfo)

将外部 UserLoginInfo 添加到指定的 user

AddPasswordAsync(TUser, String)

password仅当用户还没有密码时,才将 添加到指定的 user

AddToRoleAsync(TUser, String)

将指定的 user 添加到命名角色。

AddToRolesAsync(TUser, IEnumerable<String>)

将指定的 user 添加到命名角色。

ChangeEmailAsync(TUser, String, String)

如果指定的电子邮件更改token对用户有效,汇报用户电子邮件。

ChangePasswordAsync(TUser, String, String)

在确认指定的 currentPassword 正确后更改用户的密码,作为异步操作。

ChangePhoneNumberAsync(TUser, String, String)

如果指定的 user 更改 token 有效,则为指定的 设置电话号码。

CheckPasswordAsync(TUser, String)

返回一个标志,指示给定 password 的 是否对指定的 user有效。

ConfirmEmailAsync(TUser, String)

验证电子邮件确认令牌是否与指定的 user匹配。

CountRecoveryCodesAsync(TUser)

返回对用户仍然有效的恢复代码数。

CreateAsync(TUser)

创建后备存储中指定 user 且不带密码的 ,作为异步操作。

CreateAsync(TUser, String)

使用给定密码在后备存储区中创建指定的 user ,作为异步操作。

CreateSecurityTokenAsync(TUser)

从用户的安全标记创建要用作安全令牌的字节。

CreateTwoFactorRecoveryCode()

生成新的恢复代码。

DeleteAsync(TUser)

从后备存储中删除指定的 user

Dispose()

释放用户管理器使用的所有资源。

Dispose(Boolean)

释放角色管理器使用的非托管资源,并选择性地释放托管资源。

FindByEmailAsync(String)

获取与指定电子邮件地址的规范化值关联的用户(如果有)。 注意:建议在使用此方法时将 identityOptions.User.RequireUniqueEmail 设置为 true,否则如果存在具有重复电子邮件的用户,存储可能会引发。

FindByIdAsync(String)

查找并返回具有指定 userId的用户(如果有)。

FindByLoginAsync(String, String)

检索与指定的外部登录提供程序和登录提供程序密钥关联的用户。

FindByNameAsync(String)

查找并返回具有指定用户名的用户(如果有)。

GenerateChangeEmailTokenAsync(TUser, String)

为指定用户生成电子邮件更改令牌。

GenerateChangePhoneNumberTokenAsync(TUser, String)

为指定用户生成电话号码更改令牌。

GenerateConcurrencyStampAsync(TUser)

生成一个适合用于并发跟踪的值。

GenerateEmailConfirmationTokenAsync(TUser)

为指定用户生成电子邮件确认令牌。

GenerateNewAuthenticatorKey()

生成新的 base32 编码的 160 位安全机密, (SHA1 哈希) 的大小。

GenerateNewTwoFactorRecoveryCodesAsync(TUser, Int32)

为用户生成恢复代码,这会使用户以前的任何恢复代码失效。

GeneratePasswordResetTokenAsync(TUser)

使用配置的密码重置令牌提供程序为指定的 user生成密码重置令牌。

GenerateTwoFactorTokenAsync(TUser, String)

获取指定 user的双因素身份验证令牌。

GenerateUserTokenAsync(TUser, String, String)

为给定 user 的 和 purpose生成令牌。

GetAccessFailedCountAsync(TUser)

检索给定 user的当前失败访问数。

GetAuthenticationTokenAsync(TUser, String, String)

返回用户的身份验证令牌。

GetAuthenticatorKeyAsync(TUser)

返回用户的验证器密钥。

GetChangeEmailTokenPurpose(String)

生成用于更改电子邮件的令牌目的。

GetClaimsAsync(TUser)

Claim获取要属于指定user为异步操作的 的列表。

GetEmailAsync(TUser)

获取指定 user的电子邮件地址。

GetLockoutEnabledAsync(TUser)

检索指示是否可以为指定用户启用用户锁定的标志。

GetLockoutEndDateAsync(TUser)

获取用户最后 DateTimeOffset 一次锁定过期(如果有)。 过去的时间值表示用户当前未锁定。

GetLoginsAsync(TUser)

检索指定 的关联登录名。

GetPhoneNumberAsync(TUser)

获取指定 user的电话号码(如果有)。

GetRolesAsync(TUser)

获取指定 user 所属的角色名称的列表。

GetSecurityStampAsync(TUser)

获取指定 user的安全标记。

GetTwoFactorEnabledAsync(TUser)

返回一个标志,指示指定的 user 是否启用双重身份验证,作为异步操作。

GetUserAsync(ClaimsPrincipal)

返回与主体中的 IdentityOptions.ClaimsIdentity.UserIdClaimType 声明相对应的用户或 null。

GetUserId(ClaimsPrincipal)

如果存在,则返回用户 ID 声明值,否则返回 null。

GetUserIdAsync(TUser)

获取指定 user的用户标识符。

GetUserName(ClaimsPrincipal)

如果存在,则返回 Name 声明值,否则返回 null。

GetUserNameAsync(TUser)

获取指定 user的用户名。

GetUsersForClaimAsync(Claim)

返回用户存储区中具有指定 claim的用户的列表。

GetUsersInRoleAsync(String)

从用户存储中返回用户的列表,这些用户是指定 roleName的成员。

GetValidTwoFactorProvidersAsync(TUser)

获取指定 user的有效双因素令牌提供程序的列表,作为异步操作。

HasPasswordAsync(TUser)

获取一个标志,指示指定的 user 是否具有密码。

IsEmailConfirmedAsync(TUser)

获取一个标志,指示指定 user 的电子邮件地址是否已验证;如果电子邮件地址被验证为 false,则为 true。

IsInRoleAsync(TUser, String)

返回一个标志,指示指定的 user 是否是给定命名角色的成员。

IsLockedOutAsync(TUser)

返回一个标志,指示指定的 user 是否作为异步操作被锁定。

IsPhoneNumberConfirmedAsync(TUser)

获取一个标志,指示是否已确认指定的 user电话号码。

NormalizeEmail(String)

规范化电子邮件,以便进行一致的比较。

NormalizeKey(String)

规范化密钥 (用户名、电子邮件) ,以便进行一致的比较。

NormalizeName(String)

规范化用户或角色名称,以便进行一致的比较。

RedeemTwoFactorRecoveryCodeAsync(TUser, String)

返回恢复代码是否对用户有效。 注意:恢复代码仅有效一次,使用后将无效。

RegisterTokenProvider(String, IUserTwoFactorTokenProvider<TUser>)

注册令牌提供程序。

RemoveAuthenticationTokenAsync(TUser, String, String)

删除用户的身份验证令牌。

RemoveClaimAsync(TUser, Claim)

从给定 user中删除指定的 claim

RemoveClaimsAsync(TUser, IEnumerable<Claim>)

从给定 user中删除指定的 claims

RemoveFromRoleAsync(TUser, String)

从命名角色中删除指定的 user

RemoveFromRolesAsync(TUser, IEnumerable<String>)

从命名角色中删除指定的 user

RemoveLoginAsync(TUser, String, String)

尝试从指定的 user中删除提供的外部登录信息。 和 返回一个标志,指示删除是否成功。

RemovePasswordAsync(TUser)

删除用户的密码。

RemovePasswordAsync(TUser, CancellationToken)

删除用户的密码。

ReplaceClaimAsync(TUser, Claim, Claim)

将指定 user 上的给定 claim 替换为newClaim

ResetAccessFailedCountAsync(TUser)

重置指定 user的访问失败计数。

ResetAuthenticatorKeyAsync(TUser)

重置用户的验证器密钥。

ResetPasswordAsync(TUser, String, String)

验证user给定的密码重置后,将 的密码重置token为指定的 newPassword

SetAuthenticationTokenAsync(TUser, String, String, String)

设置用户的身份验证令牌。

SetEmailAsync(TUser, String)

设置 emailuser地址。

SetLockoutEnabledAsync(TUser, Boolean)

设置一个标志,指示指定的 user 是否被锁定,作为异步操作。

SetLockoutEndDateAsync(TUser, Nullable<DateTimeOffset>)

锁定用户,直到指定的结束日期结束。 设置过去的结束日期会立即解锁用户。

SetPhoneNumberAsync(TUser, String)

设置指定 user的电话号码。

SetTwoFactorEnabledAsync(TUser, Boolean)

设置一个标志,该标志指示指定的 user 是否启用双因素身份验证,作为异步操作。

SetUserNameAsync(TUser, String)

为指定的 user设置给定userName的 。

ThrowIfDisposed()

如果此类已被释放,则引发 。

UpdateAsync(TUser)

汇报user后备存储中指定的 。

UpdateNormalizedEmailAsync(TUser)

汇报指定 user的规范化电子邮件。

UpdateNormalizedUserNameAsync(TUser)

汇报指定 user的规范化用户名。

UpdatePasswordHash(TUser, String, Boolean)

汇报用户的密码哈希。

UpdateSecurityStampAsync(TUser)

为指定的 user重新生成安全标记。

UpdateUserAsync(TUser)

调用以在验证和更新规范化的电子邮件/用户名后更新用户。

ValidatePasswordAsync(TUser, String)

如果验证成功,应返回 Success 。 这是在更新密码哈希之前调用的。

ValidateUserAsync(TUser)

如果验证成功,应返回 Success 。 这是在通过创建或更新保存用户之前调用的。

VerifyChangePhoneNumberTokenAsync(TUser, String, String)

返回一个标志,该标志指示指定的 user的电话号码更改验证令牌是否对给定 phoneNumber的 有效。

VerifyPasswordAsync(IUserPasswordStore<TUser>, TUser, String)

返回一个 PasswordVerificationResult ,指示密码哈希比较的结果。

VerifyTwoFactorTokenAsync(TUser, String, String)

针对 user验证指定的双因素身份验证token

VerifyUserTokenAsync(TUser, String, String, String)

返回一个标志,该标志指示指定的 token 是否对给定 user 的 和 purpose有效。

适用于