AuthenticationHttpContextExtensions.SignOutAsync Method

  • Reference

Definition

Namespace:
Microsoft.AspNetCore.Authentication
Assembly:
Microsoft.AspNetCore.Authentication.Abstractions.dll
Package:
Microsoft.AspNetCore.Authentication.Abstractions v2.0.0
Package:
Microsoft.AspNetCore.Authentication.Abstractions v2.1.0
Package:
Microsoft.AspNetCore.Authentication.Abstractions 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

Overloads

SignOutAsync(HttpContext, String)

Sign out a principal for the specified scheme.
SignOutAsync(HttpContext)

Sign out a principal for the default authentication scheme. The default scheme for signing out can be configured using DefaultSignOutScheme.
SignOutAsync(HttpContext, AuthenticationProperties)

Sign out a principal for the default authentication scheme. The default scheme for signing out can be configured using DefaultSignOutScheme.
SignOutAsync(HttpContext, String, AuthenticationProperties)

Sign out a principal for the specified scheme.

SignOutAsync(HttpContext, String)

Source:
AuthenticationHttpContextExtensions.cs
Source:
AuthenticationHttpContextExtensions.cs

Sign out a principal for the specified scheme.

public:
[System::Runtime::CompilerServices::Extension]
 static System::Threading::Tasks::Task ^ SignOutAsync(Microsoft::AspNetCore::Http::HttpContext ^ context, System::String ^ scheme);
public static System.Threading.Tasks.Task SignOutAsync (this Microsoft.AspNetCore.Http.HttpContext context, string scheme);
public static System.Threading.Tasks.Task SignOutAsync (this Microsoft.AspNetCore.Http.HttpContext context, string? scheme);
static member SignOutAsync : Microsoft.AspNetCore.Http.HttpContext * string -> System.Threading.Tasks.Task
<Extension()>
Public Function SignOutAsync (context As HttpContext, scheme As String) As Task

Parameters

context
HttpContext

The HttpContext context.

scheme
String

The name of the authentication scheme.

Returns

Task

The task.

Applies to

SignOutAsync(HttpContext)

Source:
AuthenticationHttpContextExtensions.cs
Source:
AuthenticationHttpContextExtensions.cs

Sign out a principal for the default authentication scheme. The default scheme for signing out can be configured using DefaultSignOutScheme.

public:
[System::Runtime::CompilerServices::Extension]
 static System::Threading::Tasks::Task ^ SignOutAsync(Microsoft::AspNetCore::Http::HttpContext ^ context);
public static System.Threading.Tasks.Task SignOutAsync (this Microsoft.AspNetCore.Http.HttpContext context);
static member SignOutAsync : Microsoft.AspNetCore.Http.HttpContext -> System.Threading.Tasks.Task
<Extension()>
Public Function SignOutAsync (context As HttpContext) As Task

Parameters

context
HttpContext

The HttpContext context.

Returns

Task

The task.

Applies to

SignOutAsync(HttpContext, AuthenticationProperties)

Source:
AuthenticationHttpContextExtensions.cs
Source:
AuthenticationHttpContextExtensions.cs

Sign out a principal for the default authentication scheme. The default scheme for signing out can be configured using DefaultSignOutScheme.

public:
[System::Runtime::CompilerServices::Extension]
 static System::Threading::Tasks::Task ^ SignOutAsync(Microsoft::AspNetCore::Http::HttpContext ^ context, Microsoft::AspNetCore::Authentication::AuthenticationProperties ^ properties);
public static System.Threading.Tasks.Task SignOutAsync (this Microsoft.AspNetCore.Http.HttpContext context, Microsoft.AspNetCore.Authentication.AuthenticationProperties properties);
public static System.Threading.Tasks.Task SignOutAsync (this Microsoft.AspNetCore.Http.HttpContext context, Microsoft.AspNetCore.Authentication.AuthenticationProperties? properties);
static member SignOutAsync : Microsoft.AspNetCore.Http.HttpContext * Microsoft.AspNetCore.Authentication.AuthenticationProperties -> System.Threading.Tasks.Task
<Extension()>
Public Function SignOutAsync (context As HttpContext, properties As AuthenticationProperties) As Task

Parameters

context
HttpContext

The HttpContext context.

properties
AuthenticationProperties

The AuthenticationProperties properties.

Returns

Task

The task.

Applies to

SignOutAsync(HttpContext, String, AuthenticationProperties)

Source:
AuthenticationHttpContextExtensions.cs
Source:
AuthenticationHttpContextExtensions.cs

Sign out a principal for the specified scheme.

public:
[System::Runtime::CompilerServices::Extension]
 static System::Threading::Tasks::Task ^ SignOutAsync(Microsoft::AspNetCore::Http::HttpContext ^ context, System::String ^ scheme, Microsoft::AspNetCore::Authentication::AuthenticationProperties ^ properties);
public static System.Threading.Tasks.Task SignOutAsync (this Microsoft.AspNetCore.Http.HttpContext context, string scheme, Microsoft.AspNetCore.Authentication.AuthenticationProperties properties);
public static System.Threading.Tasks.Task SignOutAsync (this Microsoft.AspNetCore.Http.HttpContext context, string? scheme, Microsoft.AspNetCore.Authentication.AuthenticationProperties? properties);
static member SignOutAsync : Microsoft.AspNetCore.Http.HttpContext * string * Microsoft.AspNetCore.Authentication.AuthenticationProperties -> System.Threading.Tasks.Task
<Extension()>
Public Function SignOutAsync (context As HttpContext, scheme As String, properties As AuthenticationProperties) As Task

Parameters

context
HttpContext

The HttpContext context.

scheme
String

The name of the authentication scheme.

properties
AuthenticationProperties

The AuthenticationProperties properties.

Returns

Task

The task.

Applies to