AuthenticationHttpContextExtensions Class

Definition

Namespace:

Microsoft.AspNetCore.Authentication

Assembly:

Microsoft.AspNetCore.Authentication.Abstractions.dll

Package:

Microsoft.AspNetCore.App.Ref v8.0.0

Extension methods to expose Authentication on HttpContext.

public ref class AuthenticationHttpContextExtensions abstract sealed

public static class AuthenticationHttpContextExtensions

type AuthenticationHttpContextExtensions = class

Public Module AuthenticationHttpContextExtensions

Inheritance

Object

AuthenticationHttpContextExtensions

Methods

AuthenticateAsync(HttpContext)	Authenticate the current request using the default authentication scheme. The default authentication scheme can be configured using DefaultAuthenticateScheme.
AuthenticateAsync(HttpContext, String)	Authenticate the current request using the specified scheme.
ChallengeAsync(HttpContext)	Challenge the current request using the default challenge scheme. An authentication challenge can be issued when an unauthenticated user requests an endpoint that requires authentication. The default challenge scheme can be configured using DefaultChallengeScheme.
ChallengeAsync(HttpContext, AuthenticationProperties)	Challenge the current request using the default challenge scheme. An authentication challenge can be issued when an unauthenticated user requests an endpoint that requires authentication. The default challenge scheme can be configured using DefaultChallengeScheme.
ChallengeAsync(HttpContext, String)	Challenge the current request using the specified scheme. An authentication challenge can be issued when an unauthenticated user requests an endpoint that requires authentication.
ChallengeAsync(HttpContext, String, AuthenticationProperties)	Challenge the current request using the specified scheme. An authentication challenge can be issued when an unauthenticated user requests an endpoint that requires authentication.
ForbidAsync(HttpContext)	Forbid the current request using the default forbid scheme. Forbid is used when an authenticated user attempts to access a resource they are not permitted to access. The default forbid scheme can be configured using DefaultForbidScheme.
ForbidAsync(HttpContext, AuthenticationProperties)	Forbid the current request using the default forbid scheme. Forbid is used when an authenticated user attempts to access a resource they are not permitted to access. The default forbid scheme can be configured using DefaultForbidScheme.
ForbidAsync(HttpContext, String)	Forbid the current request using the specified scheme. Forbid is used when an authenticated user attempts to access a resource they are not permitted to access.
ForbidAsync(HttpContext, String, AuthenticationProperties)	Forbid the current request using the specified scheme. Forbid is used when an authenticated user attempts to access a resource they are not permitted to access.
GetTokenAsync(HttpContext, String)	Authenticates the request using the default authentication scheme and returns the value for the token. The default authentication scheme can be configured using DefaultAuthenticateScheme.
GetTokenAsync(HttpContext, String, String)	Authenticates the request using the specified scheme and returns the value for the token.
SignInAsync(HttpContext, ClaimsPrincipal)	Sign in a principal for the default authentication scheme. The default scheme for signing in can be configured using DefaultSignInScheme.
SignInAsync(HttpContext, ClaimsPrincipal, AuthenticationProperties)	Sign in a principal for the default authentication scheme. The default scheme for signing in can be configured using DefaultSignInScheme.
SignInAsync(HttpContext, String, ClaimsPrincipal)	Sign in a principal for the specified scheme.
SignInAsync(HttpContext, String, ClaimsPrincipal, AuthenticationProperties)	Sign in 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)	Sign out a principal for the specified scheme.
SignOutAsync(HttpContext, String, AuthenticationProperties)	Sign out a principal for the specified scheme.