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 設為 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)

傳回使用者的驗證 token。

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)

傳回使用者識別碼宣告值(如果有的話),否則傳回 null。

GetUserIdAsync(TUser)

取得指定之的使用者識別碼 user

GetUserName(ClaimsPrincipal)

如果有的話,會傳回名稱宣告值,否則會傳回 null。

GetUserNameAsync(TUser)

取得所指定的使用者名稱 user

GetUsersForClaimAsync(Claim)

從使用者存放區傳回具有指定之的使用者清單 claim

GetUsersInRoleAsync(String)

傳回使用者存放區中的使用者清單,這些使用者是指定之的成員 roleName

GetValidTwoFactorProvidersAsync(TUser)

以非同步作業的方式,取得所指定的有效雙因素權杖提供者清單 user

HasPasswordAsync(TUser)

取得旗標,指出指定的是否 user 有密碼。

IsEmailConfirmedAsync(TUser)

取得旗標,指出是否已驗證指定的電子郵件地址 user ,如果電子郵件地址已驗證,則為 true,否則為 false。

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)

從指定的移除指定的 claim user

RemoveClaimsAsync(TUser, IEnumerable<Claim>)

從指定的移除指定的 claims user

RemoveFromRoleAsync(TUser, String)

user從命名角色中移除指定的。

RemoveFromRolesAsync(TUser, IEnumerable<String>)

user從命名角色中移除指定的。

RemoveLoginAsync(TUser, String, String)

嘗試從指定的移除提供的外部登入資訊 user 。 並傳回旗標,指出移除是否成功。

RemovePasswordAsync(TUser)

移除使用者的密碼。

RemovePasswordAsync(TUser, CancellationToken)

移除使用者的密碼。

ReplaceClaimAsync(TUser, Claim, Claim)

claim以指定的取代指定的 usernewClaim

ResetAccessFailedCountAsync(TUser)

重設指定之的存取失敗計數 user

ResetAuthenticatorKeyAsync(TUser)

重設使用者的驗證者金鑰。

ResetPasswordAsync(TUser, String, String)

user newPassword 驗證指定的密碼重設之後,將的密碼重設為指定的 token

SetAuthenticationTokenAsync(TUser, String, String, String)

設定使用者的驗證權杖。

SetEmailAsync(TUser, String)

設定的 email 位址 user

SetLockoutEnabledAsync(TUser, Boolean)

設定旗標,指出指定的是否 user 已鎖定,作為非同步作業。

SetLockoutEndDateAsync(TUser, Nullable<DateTimeOffset>)

鎖定使用者,直到超過指定的結束日期為止。 設定過去的結束日期會立即解除鎖定使用者。

SetPhoneNumberAsync(TUser, String)

設定指定之的電話號碼 user

SetTwoFactorEnabledAsync(TUser, Boolean)

設定旗標,指出指定的是否 user 已啟用雙因素驗證(非同步作業)。

SetUserNameAsync(TUser, String)

userName為指定的設定指定的 user

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如果驗證成功,則應傳回。 這是在透過 Create 或 Update 儲存使用者之前呼叫。

VerifyChangePhoneNumberTokenAsync(TUser, String, String)

傳回旗標,指出指定的 user 電話號碼變更驗證權杖是否有效 phoneNumber

VerifyPasswordAsync(IUserPasswordStore<TUser>, TUser, String)

傳回 PasswordVerificationResult ,表示密碼雜湊比較的結果。

VerifyTwoFactorTokenAsync(TUser, String, String)

針對驗證指定的雙因素驗證 token user

VerifyUserTokenAsync(TUser, String, String, String)

傳回旗標,指出指定的是否對 token 給定的 user 和有效 purpose

適用於