JwtBearerChallengeContext Class

  • Reference

Definition

Namespace:
Microsoft.AspNetCore.Authentication.JwtBearer
Assembly:
Microsoft.AspNetCore.Authentication.JwtBearer.dll
Package:
Microsoft.AspNetCore.Authentication.JwtBearer v1.0.0
Package:
Microsoft.AspNetCore.Authentication.JwtBearer v1.1.0
Package:
Microsoft.AspNetCore.Authentication.JwtBearer v2.0.0
Package:
Microsoft.AspNetCore.Authentication.JwtBearer v2.1.0
Package:
Microsoft.AspNetCore.Authentication.JwtBearer v2.2.0
Package:
Microsoft.AspNetCore.Authentication.JwtBearer v3.0.3
Package:
Microsoft.AspNetCore.Authentication.JwtBearer v3.1.18
Package:
Microsoft.AspNetCore.Authentication.JwtBearer v5.0.9
Package:
Microsoft.AspNetCore.Authentication.JwtBearer v6.0.6
Package:
Microsoft.AspNetCore.Authentication.JwtBearer v7.0.5
Package:
Microsoft.AspNetCore.Authentication.JwtBearer v8.0.0
Source:
JwtBearerChallengeContext.cs
Source:
JwtBearerChallengeContext.cs
Source:
JwtBearerChallengeContext.cs
Source:
JwtBearerChallengeContext.cs
Source:
JwtBearerChallengeContext.cs
Source:
JwtBearerChallengeContext.cs
Source:
JwtBearerChallengeContext.cs
Source:
JwtBearerChallengeContext.cs

A PropertiesContext<TOptions> when access to a resource authenticated using JWT bearer is challenged.

public ref class JwtBearerChallengeContext : Microsoft::AspNetCore::Authentication::JwtBearer::BaseJwtBearerContext
public ref class JwtBearerChallengeContext : Microsoft::AspNetCore::Authentication::PropertiesContext<Microsoft::AspNetCore::Authentication::JwtBearer::JwtBearerOptions ^>
public class JwtBearerChallengeContext : Microsoft.AspNetCore.Authentication.JwtBearer.BaseJwtBearerContext
public class JwtBearerChallengeContext : Microsoft.AspNetCore.Authentication.PropertiesContext<Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerOptions>
type JwtBearerChallengeContext = class
    inherit BaseJwtBearerContext
type JwtBearerChallengeContext = class
    inherit PropertiesContext<JwtBearerOptions>
Public Class JwtBearerChallengeContext
Inherits BaseJwtBearerContext
Public Class JwtBearerChallengeContext
Inherits PropertiesContext(Of JwtBearerOptions)
Inheritance
Object
BaseContext
BaseControlContext
BaseJwtBearerContext
JwtBearerChallengeContext
Inheritance
Object
BaseContext<TOptions>
PropertiesContext<JwtBearerOptions>
JwtBearerChallengeContext

Constructors

JwtBearerChallengeContext(HttpContext, AuthenticationScheme, JwtBearerOptions, AuthenticationProperties)

Initializes a new instance of JwtBearerChallengeContext.
JwtBearerChallengeContext(HttpContext, JwtBearerOptions, AuthenticationProperties)

Properties

AuthenticateFailure

Any failures encountered during the authentication process.
Error

Gets or sets the "error" value returned to the caller as part of the WWW-Authenticate header. This property may be null when IncludeErrorDetails is set to false.
ErrorDescription

Gets or sets the "error_description" value returned to the caller as part of the WWW-Authenticate header. This property may be null when IncludeErrorDetails is set to false.
ErrorUri

Gets or sets the "error_uri" value returned to the caller as part of the WWW-Authenticate header. This property is always null unless explicitly set.
Handled

If true, will skip any default logic for this challenge.
HandledResponse (Inherited from BaseControlContext)
HttpContext (Inherited from BaseContext)
HttpContext

The context.

(Inherited from BaseContext<TOptions>)
Options (Inherited from BaseJwtBearerContext)
Options

Gets the authentication options associated with the scheme.

(Inherited from BaseContext<TOptions>)
Properties
Properties

Gets or sets the AuthenticationProperties.

(Inherited from PropertiesContext<TOptions>)
Request (Inherited from BaseContext)
Request

The request.

(Inherited from BaseContext<TOptions>)
Response (Inherited from BaseContext)
Response

The response.

(Inherited from BaseContext<TOptions>)
Scheme

The authentication scheme.

(Inherited from BaseContext<TOptions>)
Skipped (Inherited from BaseControlContext)
State (Inherited from BaseControlContext)
Ticket

Gets or set the Ticket to return if this event signals it handled the event.

(Inherited from BaseControlContext)

Methods

CheckEventResult(AuthenticateResult) (Inherited from BaseControlContext)
HandleResponse()

Skips any default logic for this challenge.
HandleResponse()

Discontinue all processing for this request and return to the client. The caller is responsible for generating the full response. Set the Ticket to trigger SignIn.

(Inherited from BaseControlContext)
SkipToNextMiddleware()

Discontinue processing the request in the current middleware and pass control to the next one. SignIn will not be called.

(Inherited from BaseControlContext)

Applies to