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)

如果指定的變更 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)

為指定的 userpurpose 產生權杖。

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)

將電子郵件正規化,以進行一致的比較。

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)

將指定的 上指定的 claimuser 取代為 newClaim

ResetAccessFailedCountAsync(TUser)

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

ResetAuthenticatorKeyAsync(TUser)

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

ResetPasswordAsync(TUser, String, String)

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

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)

為指定的 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 是否對指定的 userpurpose 有效。

適用於