UserManager<TUser> 类

定义

命名空间:

Microsoft.AspNetCore.Identity

程序集:

Microsoft.Extensions.Identity.Core.dll

包:

Microsoft.Extensions.Identity.Core v8.0.0

Source:

UserManager.cs

提供用于在持久性存储中管理用户的 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

封装用户的类型。

继承

Object

UserManager<TUser>

派生

Microsoft.AspNetCore.Identity.AspNetUserManager<TUser>

实现

IDisposable

构造函数

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)	如果指定的更改 token 有效，则设置指定 user 的电话号码。
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)	获取作为异步操作属于指定 userClaim的列表。
GetEmailAsync(TUser)	获取指定 user的电子邮件地址。
GetLockoutEnabledAsync(TUser)	检索一个标志，指示是否可以为指定用户启用用户锁定。
GetLockoutEndDateAsync(TUser)	获取用户上次锁定过期的最后一 DateTimeOffset（如果有）。 过去的时间值表示用户当前未锁定。
GetLoginsAsync(TUser)	检索指定登录名的关联登录名。
GetPhoneNumberAsync(TUser)	获取指定 user的电话号码（如果有）。
GetRolesAsync(TUser)	获取指定 user 所属的角色名称的列表。
GetSecurityStampAsync(TUser)	获取指定 user的安全戳。
GetTwoFactorEnabledAsync(TUser)	返回一个标志，指示指定的 user 是否启用双重身份验证作为异步操作。
GetUserAsync(ClaimsPrincipal)	返回与主体或 null 中的 IdentityOptions.ClaimsIdentity.UserIdClaimType 声明对应的用户。
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)	规范化电子邮件以便进行一致的比较。
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)	删除用户的密码。
ReplaceClaimAsync(TUser, Claim, Claim)	将指定 user 上的给定 claim 替换为 newClaim
ResetAccessFailedCountAsync(TUser)	重置指定 user的访问失败计数。
ResetAuthenticatorKeyAsync(TUser)	重置用户的验证器密钥。
ResetPasswordAsync(TUser, String, String)	验证给定的密码重置 token后，将 user的密码重置为指定的 newPassword。
SetAuthenticationTokenAsync(TUser, String, String, String)	为用户设置身份验证令牌。
SetEmailAsync(TUser, String)	设置 user的 email 地址。
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有效。