SignInManager<TUser>.CheckPasswordSignInAsync Method

Definition

Namespace:

Microsoft.AspNetCore.Identity

Assembly:

Microsoft.AspNetCore.Identity.dll

Package:

Microsoft.AspNetCore.App.Ref v8.0.0

Attempts a password sign in for a user.

public:
 virtual System::Threading::Tasks::Task<Microsoft::AspNetCore::Identity::SignInResult ^> ^ CheckPasswordSignInAsync(TUser user, System::String ^ password, bool lockoutOnFailure);

public virtual System.Threading.Tasks.Task<Microsoft.AspNetCore.Identity.SignInResult> CheckPasswordSignInAsync (TUser user, string password, bool lockoutOnFailure);

abstract member CheckPasswordSignInAsync : 'User * string * bool -> System.Threading.Tasks.Task<Microsoft.AspNetCore.Identity.SignInResult>
override this.CheckPasswordSignInAsync : 'User * string * bool -> System.Threading.Tasks.Task<Microsoft.AspNetCore.Identity.SignInResult>

Public Overridable Function CheckPasswordSignInAsync (user As TUser, password As String, lockoutOnFailure As Boolean) As Task(Of SignInResult)

Parameters

user

TUser

The user to sign in.

password

String

The password to attempt to sign in with.

lockoutOnFailure

Boolean

Flag indicating if the user account should be locked if the sign in fails.

Returns

Task<SignInResult>

The task object representing the asynchronous operation containing the for the sign-in attempt.