ControllerBase.SignOut Method

Reference

Definition

Namespace:: Microsoft.AspNetCore.Mvc

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

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

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

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

SignOut()	Creates a SignOutResult.
SignOut(AuthenticationProperties)	Creates a SignOutResult with `properties`.
SignOut(String[])	Creates a SignOutResult with the specified authentication schemes.
SignOut(AuthenticationProperties, String[])	Creates a SignOutResult with the specified authentication schemes and `properties`.
SignOut(AuthenticationProperties, String[])	Creates a SignOutResult with the specified specified authentication schemes and `properties`.

SignOut()

Source:: ControllerBase.cs

Creates a SignOutResult.

public:
 virtual Microsoft::AspNetCore::Mvc::SignOutResult ^ SignOut();

[Microsoft.AspNetCore.Mvc.NonAction]
public virtual Microsoft.AspNetCore.Mvc.SignOutResult SignOut ();

[<Microsoft.AspNetCore.Mvc.NonAction>]
abstract member SignOut : unit -> Microsoft.AspNetCore.Mvc.SignOutResult
override this.SignOut : unit -> Microsoft.AspNetCore.Mvc.SignOutResult

Public Overridable Function SignOut () As SignOutResult

Returns

SignOutResult

The created SignOutResult for the response.

Attributes: NonActionAttribute

Applies to

SignOut(AuthenticationProperties)

Source:: ControllerBase.cs

Creates a SignOutResult with properties.

public:
 virtual Microsoft::AspNetCore::Mvc::SignOutResult ^ SignOut(Microsoft::AspNetCore::Authentication::AuthenticationProperties ^ properties);

[Microsoft.AspNetCore.Mvc.NonAction]
public virtual Microsoft.AspNetCore.Mvc.SignOutResult SignOut (Microsoft.AspNetCore.Authentication.AuthenticationProperties properties);

[<Microsoft.AspNetCore.Mvc.NonAction>]
abstract member SignOut : Microsoft.AspNetCore.Authentication.AuthenticationProperties -> Microsoft.AspNetCore.Mvc.SignOutResult
override this.SignOut : Microsoft.AspNetCore.Authentication.AuthenticationProperties -> Microsoft.AspNetCore.Mvc.SignOutResult

Public Overridable Function SignOut (properties As AuthenticationProperties) As SignOutResult

Parameters

properties: AuthenticationProperties

AuthenticationProperties used to perform the sign-out operation.

Returns

SignOutResult

The created SignOutResult for the response.

Attributes: NonActionAttribute

Applies to

SignOut(String[])

Source:: ControllerBase.cs

Source:: ControllerBase.cs

Source:: ControllerBase.cs

Creates a SignOutResult with the specified authentication schemes.

public:
 virtual Microsoft::AspNetCore::Mvc::SignOutResult ^ SignOut(... cli::array <System::String ^> ^ authenticationSchemes);

[Microsoft.AspNetCore.Mvc.NonAction]
public virtual Microsoft.AspNetCore.Mvc.SignOutResult SignOut (params string[] authenticationSchemes);

[<Microsoft.AspNetCore.Mvc.NonAction>]
abstract member SignOut : string[] -> Microsoft.AspNetCore.Mvc.SignOutResult
override this.SignOut : string[] -> Microsoft.AspNetCore.Mvc.SignOutResult

Public Overridable Function SignOut (ParamArray authenticationSchemes As String()) As SignOutResult

Parameters

authenticationSchemes: String[]

The authentication schemes to use for the sign-out operation.

Returns

SignOutResult

The created SignOutResult for the response.

Attributes: NonActionAttribute

Applies to

SignOut(AuthenticationProperties, String[])

Source:: ControllerBase.cs

Source:: ControllerBase.cs

Source:: ControllerBase.cs

Creates a SignOutResult with the specified authentication schemes and properties.

public:
 virtual Microsoft::AspNetCore::Mvc::SignOutResult ^ SignOut(Microsoft::AspNetCore::Authentication::AuthenticationProperties ^ properties, ... cli::array <System::String ^> ^ authenticationSchemes);

[Microsoft.AspNetCore.Mvc.NonAction]
public virtual Microsoft.AspNetCore.Mvc.SignOutResult SignOut (Microsoft.AspNetCore.Authentication.AuthenticationProperties properties, params string[] authenticationSchemes);

[<Microsoft.AspNetCore.Mvc.NonAction>]
abstract member SignOut : Microsoft.AspNetCore.Authentication.AuthenticationProperties * string[] -> Microsoft.AspNetCore.Mvc.SignOutResult
override this.SignOut : Microsoft.AspNetCore.Authentication.AuthenticationProperties * string[] -> Microsoft.AspNetCore.Mvc.SignOutResult

Public Overridable Function SignOut (properties As AuthenticationProperties, ParamArray authenticationSchemes As String()) As SignOutResult

Parameters

properties: AuthenticationProperties

AuthenticationProperties used to perform the sign-out operation.

authenticationSchemes: String[]

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

Returns

SignOutResult

The created SignOutResult for the response.

Attributes: NonActionAttribute

Applies to

SignOut(AuthenticationProperties, String[])

Creates a SignOutResult with the specified specified authentication schemes and properties.

public:
 virtual Microsoft::AspNetCore::Mvc::SignOutResult ^ SignOut(Microsoft::AspNetCore::Http::Authentication::AuthenticationProperties ^ properties, ... cli::array <System::String ^> ^ authenticationSchemes);

[Microsoft.AspNetCore.Mvc.NonAction]
public virtual Microsoft.AspNetCore.Mvc.SignOutResult SignOut (Microsoft.AspNetCore.Http.Authentication.AuthenticationProperties properties, params string[] authenticationSchemes);

[<Microsoft.AspNetCore.Mvc.NonAction>]
abstract member SignOut : Microsoft.AspNetCore.Http.Authentication.AuthenticationProperties * string[] -> Microsoft.AspNetCore.Mvc.SignOutResult
override this.SignOut : Microsoft.AspNetCore.Http.Authentication.AuthenticationProperties * string[] -> Microsoft.AspNetCore.Mvc.SignOutResult

Public Overridable Function SignOut (properties As AuthenticationProperties, ParamArray authenticationSchemes As String()) As SignOutResult

Parameters

properties: AuthenticationProperties

AuthenticationProperties used to perform the sign-out operation.

authenticationSchemes: String[]

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

Returns

SignOutResult

The created SignOutResult for the response.

Attributes: NonActionAttribute

Applies to

Share via

ControllerBase.SignOut Method

Definition

Overloads

SignOut()

Returns

Applies to

SignOut(AuthenticationProperties)

Parameters

Returns

Applies to

SignOut(String[])

Parameters

Returns

Applies to

SignOut(AuthenticationProperties, String[])

Parameters

Returns

Applies to

SignOut(AuthenticationProperties, String[])

Parameters

Returns

Applies to

Feedback

Additional resources