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 ID の構成に使用されます。
PasswordHasher	パスワードのハッシュに使用される IPasswordHasher<TUser>。
PasswordValidators	パスワードの検証に使用される IPasswordValidator<TUser>。
Store	マネージャーが操作する永続化ストアを取得または設定します。
SupportsQueryableUsers	バッキング ユーザー ストアが IQueryable 情報のコレクションの返しをサポートしているかどうかを示すフラグを取得します。
SupportsUserAuthenticationTokens	バッキング ユーザー ストアが認証トークンをサポートしているかどうかを示すフラグを取得します。
SupportsUserAuthenticatorKey	バッキング ユーザー ストアがユーザー認証をサポートしているかどうかを示すフラグを取得します。
SupportsUserClaim	バッキング ユーザー ストアがユーザー要求をサポートしているかどうかを示すフラグを取得します。
SupportsUserEmail	バッキング ユーザー ストアがユーザー メールをサポートしているかどうかを示すフラグを取得します。
SupportsUserLockout	バッキング ユーザー ストアがユーザー ロックアウトをサポートしているかどうかを示すフラグを取得します。
SupportsUserLogin	バッキング ユーザー ストアが外部ログインをサポートしているかどうかを示すフラグを取得します。
SupportsUserPassword	バッキング ユーザー ストアがユーザー パスワードをサポートしているかどうかを示すフラグを取得します。
SupportsUserPhoneNumber	バッキング ユーザー ストアがユーザーの電話番号をサポートしているかどうかを示すフラグを取得します。
SupportsUserRole	バッキング ユーザー ストアがユーザー ロールをサポートしているかどうかを示すフラグを取得します。
SupportsUserSecurityStamp	バッキング ユーザー ストアがセキュリティ スタンプをサポートしているかどうかを示すフラグを取得します。
SupportsUserTwoFactor	バッキング ユーザー ストアが 2 要素認証をサポートしているかどうかを示すフラグを取得します。
SupportsUserTwoFactorRecoveryCodes	バッキング ユーザー ストアが回復コードをサポートしているかどうかを示すフラグを取得します。
Users	ストアが IQueryableUserStore の場合、ユーザーの IQueryable を返します。
UserValidators	IUserValidator<TUser> ユーザーの検証に使用されます。

メソッド

AccessFailedAsync(TUser)	ユーザーのアクセス失敗数を非同期操作としてインクリメントします。 失敗したアクセス アカウントが構成された最大試行回数以上の場合、ユーザーは構成されたロックアウト期間に対してロックアウトされます。
AddClaimAsync(TUser, Claim)	指定した claim を userに追加します。
AddClaimsAsync(TUser, IEnumerable<Claim>)	指定した claims を userに追加します。
AddLoginAsync(TUser, UserLoginInfo)	指定した userに外部 UserLoginInfo を追加します。
AddPasswordAsync(TUser, String)	ユーザーがまだパスワードを持っていない場合にのみ、指定した user に password を追加します。
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の 2 要素認証トークンを取得します。
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 で 2 要素認証が有効になっているかどうかを示すフラグを非同期操作として返します。
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の有効な 2 要素トークン プロバイダーの一覧を非同期操作として取得します。
HasPasswordAsync(TUser)	指定した user にパスワードがあるかどうかを示すフラグを取得します。
IsEmailConfirmedAsync(TUser)	指定した user の電子メール アドレスが検証されているかどうかを示すフラグを取得します。それ以外の場合は、電子メール アドレスが検証された場合は true。
IsInRoleAsync(TUser, String)	指定した user が指定された名前付きロールのメンバーであるかどうかを示すフラグを返します。
IsLockedOutAsync(TUser)	指定した user が非同期操作としてロックアウトされているかどうかを示すフラグを返します。
IsPhoneNumberConfirmedAsync(TUser)	指定した userの電話番号が確認されているかどうかを示すフラグを取得します。
NormalizeEmail(String)	一貫性のある比較のために電子メールを正規化します。
NormalizeName(String)	ユーザー名またはロール名を正規化して、一貫性のある比較を行います。
RedeemTwoFactorRecoveryCodeAsync(TUser, String)	回復コードがユーザーに対して有効かどうかを返します。 注: 回復コードは 1 回だけ有効であり、使用後は無効になります。
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を検証した後、指定した newPassword に userのパスワードをリセットします。
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 で 2 要素認証が有効になっているかどうかを示すフラグを非同期操作として設定します。
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 を返す必要があります。 これは、Create または Update を使用してユーザーを保存する前に呼び出されます。
VerifyChangePhoneNumberTokenAsync(TUser, String, String)	指定した userの電話番号変更確認トークンが、指定された phoneNumberに対して有効かどうかを示すフラグを返します。
VerifyPasswordAsync(IUserPasswordStore<TUser>, TUser, String)	パスワード ハッシュ比較の結果を示す PasswordVerificationResult を返します。
VerifyTwoFactorTokenAsync(TUser, String, String)	userに対して指定された 2 要素認証 token を検証します。
VerifyUserTokenAsync(TUser, String, String, String)	指定した token が指定された user および purposeに対して有効かどうかを示すフラグを返します。