Results.SignIn(ClaimsPrincipal, AuthenticationProperties, String) Method

Reference

Definition

Namespace:: Microsoft.AspNetCore.Http

Assembly:: Microsoft.AspNetCore.Http.Results.dll

Package:: Microsoft.AspNetCore.App.Ref v6.0.6

Package:: Microsoft.AspNetCore.App.Ref v7.0.5

Package:: Microsoft.AspNetCore.App.Ref v8.0.0

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Creates an IResult that on execution invokes SignInAsync(HttpContext, String, ClaimsPrincipal, AuthenticationProperties).

public static Microsoft.AspNetCore.Http.IResult SignIn (System.Security.Claims.ClaimsPrincipal principal, Microsoft.AspNetCore.Authentication.AuthenticationProperties? properties = default, string? authenticationScheme = default);

static member SignIn : System.Security.Claims.ClaimsPrincipal * Microsoft.AspNetCore.Authentication.AuthenticationProperties * string -> Microsoft.AspNetCore.Http.IResult

Public Shared Function SignIn (principal As ClaimsPrincipal, Optional properties As AuthenticationProperties = Nothing, Optional authenticationScheme As String = Nothing) As IResult

Parameters

principal: ClaimsPrincipal

The ClaimsPrincipal containing the user claims.

properties: AuthenticationProperties

AuthenticationProperties used to perform the sign-in operation.

authenticationScheme: String

The authentication scheme to use for the sign-in operation.

Returns

IResult

The created IResult for the response.

Applies to