UserManager<TUser> 類別

定義

命名空間:

Microsoft.AspNetCore.Identity

組件:

Microsoft.Extensions.Identity.Core.dll

套件:

Microsoft.Extensions.Identity.Core v8.0.0

來源:

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)	釋放角色管理員所使用的 Unmanaged 資源，並選擇性地釋放受控資源。
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)	取得要屬於指定之 user 做為異步操作的 Claim清單。
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)	如果存在則傳回使用者標識碼宣告值，否則會傳回 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有效。