SignInAuthenticationHandler<TOptions>.SignInAsync Method

  • Reference

Definition

Namespace:
Microsoft.AspNetCore.Authentication
Assembly:
Microsoft.AspNetCore.Authentication.dll
Package:
Microsoft.AspNetCore.Authentication v2.1.0
Package:
Microsoft.AspNetCore.Authentication 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
Source:
SignInAuthenticationHandler.cs
Source:
SignInAuthenticationHandler.cs

Handle sign in.

public:
 virtual System::Threading::Tasks::Task ^ SignInAsync(System::Security::Claims::ClaimsPrincipal ^ user, Microsoft::AspNetCore::Authentication::AuthenticationProperties ^ properties);
public virtual System.Threading.Tasks.Task SignInAsync (System.Security.Claims.ClaimsPrincipal user, Microsoft.AspNetCore.Authentication.AuthenticationProperties properties);
public virtual System.Threading.Tasks.Task SignInAsync (System.Security.Claims.ClaimsPrincipal user, Microsoft.AspNetCore.Authentication.AuthenticationProperties? properties);
abstract member SignInAsync : System.Security.Claims.ClaimsPrincipal * Microsoft.AspNetCore.Authentication.AuthenticationProperties -> System.Threading.Tasks.Task
override this.SignInAsync : System.Security.Claims.ClaimsPrincipal * Microsoft.AspNetCore.Authentication.AuthenticationProperties -> System.Threading.Tasks.Task
Public Overridable Function SignInAsync (user As ClaimsPrincipal, properties As AuthenticationProperties) As Task

Parameters

user
ClaimsPrincipal

The ClaimsPrincipal user.

properties
AuthenticationProperties

The AuthenticationProperties that contains the extra meta-data arriving with the authentication.

Returns

Task

A task.

Implements

SignInAsync(ClaimsPrincipal, AuthenticationProperties)

Applies to