SignInManager<TUser>.CheckPasswordSignInAsync Method

  • Reference

Definition

Namespace:
Microsoft.AspNetCore.Identity
Assembly:
Microsoft.AspNetCore.Identity.dll
Package:
Microsoft.AspNetCore.Identity v1.1.0
Package:
Microsoft.AspNetCore.Identity v2.0.0
Package:
Microsoft.AspNetCore.Identity v2.1.0
Package:
Microsoft.AspNetCore.Identity v2.2.0
Package:
Microsoft.AspNetCore.App.Ref v3.0.1
Package:
Microsoft.AspNetCore.App.Ref v3.1.10
Package:
Microsoft.AspNetCore.App.Ref v5.0.0
Package:
Microsoft.AspNetCore.App.Ref v6.0.6
Package:
Microsoft.AspNetCore.App.Ref v7.0.5
Package:
Microsoft.AspNetCore.App.Ref v8.0.0
Package:
Microsoft.AspNetCore.App.Ref v9.0.0-rc.2.24474.3
Source:
SignInManager.cs
Source:
SignInManager.cs
Source:
SignInManager.cs

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.

Applies to