JwtBearerOptions Class

Initializes a new instance of JwtBearerOptions.

Gets or sets a single valid audience value for any received OpenIdConnect token. This value is passed into TokenValidationParameters.ValidAudience if that property is empty.

Gets or sets the Authority to use when making OpenIdConnect calls.

Gets or sets how often an automatic metadata refresh should occur.

The Backchannel used to retrieve metadata.

The HttpMessageHandler used to retrieve metadata. This cannot be set at the same time as BackchannelCertificateValidator unless the value is a WebRequestHandler.

Gets or sets the timeout when using the backchannel to make an http call.

Gets or sets the challenge to put in the "WWW-Authenticate" header.

Gets or sets the issuer that should be used for any claims that are created

Configuration provided directly by the developer. If provided, then MetadataAddress and the Backchannel properties will not be used. This information should not be updated during request processing.

Responsible for retrieving, caching, and refreshing the configuration from metadata. If not provided, then one will be created using the MetadataAddress and Backchannel properties.

The object provided by the application to process events raised by the bearer authentication handler. The application may implement the interface fully, or it may create an instance of JwtBearerEvents and assign delegates only to the events it wants to process.

If set, will be used as the service type to get the Events instance instead of the property.

If set, this specifies the target scheme that this scheme should forward AuthenticateAsync calls to. For example Context.AuthenticateAsync("ThisScheme") => Context.AuthenticateAsync("ForwardAuthenticateValue"); Set the target to the current scheme to disable forwarding and allow normal processing.

If set, this specifies the target scheme that this scheme should forward ChallengeAsync calls to. For example Context.ChallengeAsync("ThisScheme") => Context.ChallengeAsync("ForwardChallengeValue"); Set the target to the current scheme to disable forwarding and allow normal processing.

If set, this specifies a default scheme that authentication handlers should forward all authentication operations to by default. The default forwarding logic will check the most specific ForwardAuthenticate/Challenge/Forbid/SignIn/SignOut setting first, followed by checking the ForwardDefaultSelector, followed by ForwardDefault. The first non null result will be used as the target scheme to forward to.

Used to select a default scheme for the current request that authentication handlers should forward all authentication operations to by default. The default forwarding logic will check the most specific ForwardAuthenticate/Challenge/Forbid/SignIn/SignOut setting first, followed by checking the ForwardDefaultSelector, followed by ForwardDefault. The first non null result will be used as the target scheme to forward to.

If set, this specifies the target scheme that this scheme should forward ForbidAsync calls to. For example Context.ForbidAsync("ThisScheme") => Context.ForbidAsync("ForwardForbidValue"); Set the target to the current scheme to disable forwarding and allow normal processing.

If set, this specifies the target scheme that this scheme should forward SignInAsync calls to. For example Context.SignInAsync("ThisScheme") => Context.SignInAsync("ForwardSignInValue"); Set the target to the current scheme to disable forwarding and allow normal processing.

If set, this specifies the target scheme that this scheme should forward SignOutAsync calls to. For example Context.SignOutAsync("ThisScheme") => Context.SignOutAsync("ForwardSignOutValue"); Set the target to the current scheme to disable forwarding and allow normal processing.

Defines whether the token validation errors should be returned to the caller. Enabled by default, this option can be disabled to prevent the JWT handler from returning an error and an error_description in the WWW-Authenticate header.

Gets or sets the MapInboundClaims property on the default instance of JwtSecurityTokenHandler in SecurityTokenValidators, or JsonWebTokenHandler in TokenHandlers, which is used when determining whether or not to map claim types that are extracted when validating a JwtSecurityToken or a JsonWebToken.

If this is set to true, the Claim Type is set to the JSON claim 'name' after translating using this mapping. Otherwise, no mapping occurs.

The default value is true.

Gets or sets the discovery endpoint for obtaining metadata

Gets or sets the minimum time between retrievals, in the event that a retrieval failed, or that a refresh was explicitly requested.

Gets or sets if a metadata refresh should be attempted after a SecurityTokenSignatureKeyNotFoundException. This allows for automatic recovery in the event of a signature key rollover. This is enabled by default.

Gets or sets if HTTPS is required for the metadata address or authority. The default is true. This should be disabled only in development environments.

Defines whether the bearer token should be stored in the AuthenticationProperties after a successful authorization.

Gets the ordered list of ISecurityTokenValidator used to validate access tokens.

Used for testing.

Gets the ordered list of TokenHandler used to validate access tokens.

Gets or sets the parameters used to validate identity tokens.

Gets or sets whether TokenHandlers or SecurityTokenValidators will be used to validate the inbound token.

Check that the options are valid. Should throw an exception if things are not ok.

Checks that the options are valid for a specific scheme