AuthorizationCodeReceivedContext Class

Definition

Namespace:

Microsoft.AspNetCore.Authentication.OpenIdConnect

Assembly:

Microsoft.AspNetCore.Authentication.OpenIdConnect.dll

Package:

Microsoft.AspNetCore.Authentication.OpenIdConnect v9.0.0

Source:

AuthorizationCodeReceivedContext.cs

This Context can be used to be informed when an 'AuthorizationCode' is received over the OpenIdConnect protocol.

public class AuthorizationCodeReceivedContext : Microsoft.AspNetCore.Authentication.RemoteAuthenticationContext<Microsoft.AspNetCore.Authentication.OpenIdConnect.OpenIdConnectOptions>

type AuthorizationCodeReceivedContext = class
    inherit RemoteAuthenticationContext<OpenIdConnectOptions>

Public Class AuthorizationCodeReceivedContext
Inherits RemoteAuthenticationContext(Of OpenIdConnectOptions)

Inheritance

Object

BaseContext<TOptions>

HandleRequestContext<TOptions>

RemoteAuthenticationContext<OpenIdConnectOptions>

AuthorizationCodeReceivedContext

Constructors

AuthorizationCodeReceivedContext(HttpContext, AuthenticationScheme, OpenIdConnectOptions, AuthenticationProperties)

Creates a AuthorizationCodeReceivedContext

Properties

Backchannel	The configured communication channel to the identity provider for use when making custom requests to the token endpoint.
HandledCodeRedemption	Indicates if the developer choose to handle (or skip) the code redemption. If true then the handler will not attempt to redeem the code. See HandleCodeRedemption and TokenEndpointResponse.
HttpContext	The context. (Inherited from BaseContext<TOptions>)
JwtSecurityToken	Gets or sets the JwtSecurityToken that was received in the authentication response, if any.
Options	Gets the authentication options associated with the scheme. (Inherited from BaseContext<TOptions>)
Principal	Gets the ClaimsPrincipal containing the user claims. (Inherited from RemoteAuthenticationContext<TOptions>)
Properties	Gets or sets the AuthenticationProperties. (Inherited from RemoteAuthenticationContext<TOptions>)
ProtocolMessage	Gets or sets the OpenIdConnectMessage.
Request	The request. (Inherited from BaseContext<TOptions>)
Response	The response. (Inherited from BaseContext<TOptions>)
Result	The HandleRequestResult which is used by the handler. (Inherited from HandleRequestContext<TOptions>)
Scheme	The authentication scheme. (Inherited from BaseContext<TOptions>)
TokenEndpointRequest	The request that will be sent to the token endpoint and is available for customization.
TokenEndpointResponse	If the developer chooses to redeem the code themselves then they can provide the resulting tokens here. This is the same as calling HandleCodeRedemption. If set then the handler will not attempt to redeem the code. An IdToken is required if one had not been previously received in the authorization response. An access token is optional if the handler is to contact the user-info endpoint.

Methods

Fail(Exception)	Indicates that authentication failed. (Inherited from RemoteAuthenticationContext<TOptions>)
Fail(String)	Indicates that authentication failed. (Inherited from RemoteAuthenticationContext<TOptions>)
HandleCodeRedemption()	Tells the handler to skip the code redemption process. The developer may have redeemed the code themselves, or decided that the redemption was not required. If tokens were retrieved that are needed for further processing then call one of the overloads that allows providing tokens. An IdToken is required if one had not been previously received in the authorization response. An access token can optionally be provided for the handler to contact the user-info endpoint. Calling this is the same as setting TokenEndpointResponse.
HandleCodeRedemption(OpenIdConnectMessage)	Tells the handler to skip the code redemption process. The developer may have redeemed the code themselves, or decided that the redemption was not required. If tokens were retrieved that are needed for further processing then call one of the overloads that allows providing tokens. An IdToken is required if one had not been previously received in the authorization response. An access token can optionally be provided for the handler to contact the user-info endpoint. Calling this is the same as setting TokenEndpointResponse.
HandleCodeRedemption(String, String)	Tells the handler to skip the code redemption process. The developer may have redeemed the code themselves, or decided that the redemption was not required. If tokens were retrieved that are needed for further processing then call one of the overloads that allows providing tokens. An IdToken is required if one had not been previously received in the authorization response. An access token can optionally be provided for the handler to contact the user-info endpoint. Calling this is the same as setting TokenEndpointResponse.
HandleResponse()	Discontinue all processing for this request and return to the client. The caller is responsible for generating the full response. (Inherited from HandleRequestContext<TOptions>)
SkipHandler()	Discontinue processing the request in the current handler. (Inherited from HandleRequestContext<TOptions>)
Success()	Calls success creating a ticket with the Principal and Properties. (Inherited from RemoteAuthenticationContext<TOptions>)