ControllerBase.SignIn Method

Reference

Definition

Namespace:: Microsoft.AspNetCore.Mvc

Assembly:: Microsoft.AspNetCore.Mvc.Core.dll

Package:: Microsoft.AspNetCore.Mvc.Core v1.0.0

Package:: Microsoft.AspNetCore.Mvc.Core v1.1.0

Package:: Microsoft.AspNetCore.Mvc.Core v2.0.0

Package:: Microsoft.AspNetCore.Mvc.Core v2.1.0

Package:: Microsoft.AspNetCore.Mvc.Core 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

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.

Overloads

SignIn(ClaimsPrincipal, AuthenticationProperties, String)	Creates a SignInResult with the specified specified authentication scheme and `properties`.
SignIn(ClaimsPrincipal, AuthenticationProperties, String)	Creates a SignInResult with the specified authentication scheme and `properties`.
SignIn(ClaimsPrincipal, String)	Creates a SignInResult with the specified authentication scheme.
SignIn(ClaimsPrincipal, AuthenticationProperties)	Creates a SignInResult with `properties`.
SignIn(ClaimsPrincipal)	Creates a SignInResult.

Creates a SignInResult with the specified specified authentication scheme and properties.

public:
 virtual Microsoft::AspNetCore::Mvc::SignInResult ^ SignIn(System::Security::Claims::ClaimsPrincipal ^ principal, Microsoft::AspNetCore::Http::Authentication::AuthenticationProperties ^ properties, System::String ^ authenticationScheme);

[Microsoft.AspNetCore.Mvc.NonAction]
public virtual Microsoft.AspNetCore.Mvc.SignInResult SignIn (System.Security.Claims.ClaimsPrincipal principal, Microsoft.AspNetCore.Http.Authentication.AuthenticationProperties properties, string authenticationScheme);

[<Microsoft.AspNetCore.Mvc.NonAction>]
abstract member SignIn : System.Security.Claims.ClaimsPrincipal * Microsoft.AspNetCore.Http.Authentication.AuthenticationProperties * string -> Microsoft.AspNetCore.Mvc.SignInResult
override this.SignIn : System.Security.Claims.ClaimsPrincipal * Microsoft.AspNetCore.Http.Authentication.AuthenticationProperties * string -> Microsoft.AspNetCore.Mvc.SignInResult

Public Overridable Function SignIn (principal As ClaimsPrincipal, properties As AuthenticationProperties, authenticationScheme As String) As SignInResult

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

SignInResult

The created SignInResult for the response.

Attributes: NonActionAttribute

Applies to

Source:: ControllerBase.cs

Source:: ControllerBase.cs

Source:: ControllerBase.cs

Creates a SignInResult with the specified authentication scheme and properties.

public:
 virtual Microsoft::AspNetCore::Mvc::SignInResult ^ SignIn(System::Security::Claims::ClaimsPrincipal ^ principal, Microsoft::AspNetCore::Authentication::AuthenticationProperties ^ properties, System::String ^ authenticationScheme);

[Microsoft.AspNetCore.Mvc.NonAction]
public virtual Microsoft.AspNetCore.Mvc.SignInResult SignIn (System.Security.Claims.ClaimsPrincipal principal, Microsoft.AspNetCore.Authentication.AuthenticationProperties properties, string authenticationScheme);

[<Microsoft.AspNetCore.Mvc.NonAction>]
abstract member SignIn : System.Security.Claims.ClaimsPrincipal * Microsoft.AspNetCore.Authentication.AuthenticationProperties * string -> Microsoft.AspNetCore.Mvc.SignInResult
override this.SignIn : System.Security.Claims.ClaimsPrincipal * Microsoft.AspNetCore.Authentication.AuthenticationProperties * string -> Microsoft.AspNetCore.Mvc.SignInResult

Public Overridable Function SignIn (principal As ClaimsPrincipal, properties As AuthenticationProperties, authenticationScheme As String) As SignInResult

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

SignInResult

The created SignInResult for the response.

Attributes: NonActionAttribute

Applies to

Source:: ControllerBase.cs

Source:: ControllerBase.cs

Source:: ControllerBase.cs

Creates a SignInResult with the specified authentication scheme.

public:
 virtual Microsoft::AspNetCore::Mvc::SignInResult ^ SignIn(System::Security::Claims::ClaimsPrincipal ^ principal, System::String ^ authenticationScheme);

[Microsoft.AspNetCore.Mvc.NonAction]
public virtual Microsoft.AspNetCore.Mvc.SignInResult SignIn (System.Security.Claims.ClaimsPrincipal principal, string authenticationScheme);

[<Microsoft.AspNetCore.Mvc.NonAction>]
abstract member SignIn : System.Security.Claims.ClaimsPrincipal * string -> Microsoft.AspNetCore.Mvc.SignInResult
override this.SignIn : System.Security.Claims.ClaimsPrincipal * string -> Microsoft.AspNetCore.Mvc.SignInResult

Public Overridable Function SignIn (principal As ClaimsPrincipal, authenticationScheme As String) As SignInResult

Parameters

principal: ClaimsPrincipal

The ClaimsPrincipal containing the user claims.

authenticationScheme: String

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

Returns

SignInResult

The created SignInResult for the response.

Attributes: NonActionAttribute

Applies to

Source:: ControllerBase.cs

Creates a SignInResult with properties.

public:
 virtual Microsoft::AspNetCore::Mvc::SignInResult ^ SignIn(System::Security::Claims::ClaimsPrincipal ^ principal, Microsoft::AspNetCore::Authentication::AuthenticationProperties ^ properties);

[Microsoft.AspNetCore.Mvc.NonAction]
public virtual Microsoft.AspNetCore.Mvc.SignInResult SignIn (System.Security.Claims.ClaimsPrincipal principal, Microsoft.AspNetCore.Authentication.AuthenticationProperties properties);

[<Microsoft.AspNetCore.Mvc.NonAction>]
abstract member SignIn : System.Security.Claims.ClaimsPrincipal * Microsoft.AspNetCore.Authentication.AuthenticationProperties -> Microsoft.AspNetCore.Mvc.SignInResult
override this.SignIn : System.Security.Claims.ClaimsPrincipal * Microsoft.AspNetCore.Authentication.AuthenticationProperties -> Microsoft.AspNetCore.Mvc.SignInResult

Public Overridable Function SignIn (principal As ClaimsPrincipal, properties As AuthenticationProperties) As SignInResult

Parameters

principal: ClaimsPrincipal

The ClaimsPrincipal containing the user claims.

properties: AuthenticationProperties

AuthenticationProperties used to perform the sign-in operation.

Returns

SignInResult

The created SignInResult for the response.

Attributes: NonActionAttribute

Applies to

Source:: ControllerBase.cs

Creates a SignInResult.

public:
 virtual Microsoft::AspNetCore::Mvc::SignInResult ^ SignIn(System::Security::Claims::ClaimsPrincipal ^ principal);

[Microsoft.AspNetCore.Mvc.NonAction]
public virtual Microsoft.AspNetCore.Mvc.SignInResult SignIn (System.Security.Claims.ClaimsPrincipal principal);

[<Microsoft.AspNetCore.Mvc.NonAction>]
abstract member SignIn : System.Security.Claims.ClaimsPrincipal -> Microsoft.AspNetCore.Mvc.SignInResult
override this.SignIn : System.Security.Claims.ClaimsPrincipal -> Microsoft.AspNetCore.Mvc.SignInResult

Public Overridable Function SignIn (principal As ClaimsPrincipal) As SignInResult

Parameters

principal: ClaimsPrincipal

The ClaimsPrincipal containing the user claims.

Returns

SignInResult

The created SignInResult for the response.

Attributes: NonActionAttribute

Applies to

Share via

ControllerBase.SignIn Method

Definition

Overloads

Parameters

Returns

Applies to

Parameters

Returns

Applies to

Parameters

Returns

Applies to

Parameters

Returns

Applies to

Parameters

Returns

Applies to

Feedback

Additional resources

Share via

ControllerBase.SignIn Method

Definition

Overloads

SignIn(ClaimsPrincipal, AuthenticationProperties, String)

Parameters

Returns

Applies to

SignIn(ClaimsPrincipal, AuthenticationProperties, String)

Parameters

Returns

Applies to

SignIn(ClaimsPrincipal, String)

Parameters

Returns

Applies to

SignIn(ClaimsPrincipal, AuthenticationProperties)

Parameters

Returns

Applies to

SignIn(ClaimsPrincipal)

Parameters

Returns

Applies to

Feedback

Additional resources