OpenIdConnectEvents Class

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Specifies events which the OpenIdConnectHandler invokes to enable developer control over the authentication process.

public ref class OpenIdConnectEvents : Microsoft::AspNetCore::Authentication::RemoteAuthenticationEvents, Microsoft::AspNetCore::Authentication::OpenIdConnect::IOpenIdConnectEvents

public ref class OpenIdConnectEvents : Microsoft::AspNetCore::Authentication::RemoteAuthenticationEvents

public class OpenIdConnectEvents : Microsoft.AspNetCore.Authentication.RemoteAuthenticationEvents, Microsoft.AspNetCore.Authentication.OpenIdConnect.IOpenIdConnectEvents

public class OpenIdConnectEvents : Microsoft.AspNetCore.Authentication.RemoteAuthenticationEvents

type OpenIdConnectEvents = class
    inherit RemoteAuthenticationEvents
    interface IOpenIdConnectEvents
    interface IRemoteAuthenticationEvents

type OpenIdConnectEvents = class
    inherit RemoteAuthenticationEvents

Public Class OpenIdConnectEvents
Inherits RemoteAuthenticationEvents
Implements IOpenIdConnectEvents

Public Class OpenIdConnectEvents
Inherits RemoteAuthenticationEvents

Inheritance: Object

RemoteAuthenticationEvents
OpenIdConnectEvents

Implements: IRemoteAuthenticationEvents IOpenIdConnectEvents

Constructors

OpenIdConnectEvents()

Properties

OnAccessDenied	Invoked when an access denied error was returned by the remote server. (Inherited from RemoteAuthenticationEvents)
OnAuthenticationFailed	Invoked if exceptions are thrown during request processing. The exceptions will be re-thrown after this event unless suppressed.
OnAuthorizationCodeReceived	Invoked after security token validation if an authorization code is present in the protocol message.
OnMessageReceived	Invoked when a protocol message is first received.
OnRedirectToIdentityProvider	Invoked before redirecting to the identity provider to authenticate. This can be used to set ProtocolMessage.State that will be persisted through the authentication process. The ProtocolMessage can also be used to add or customize parameters sent to the identity provider.
OnRedirectToIdentityProviderForSignOut	Invoked before redirecting to the identity provider to sign out.
OnRemoteFailure	Invoked when there is a remote failure. (Inherited from RemoteAuthenticationEvents)
OnRemoteSignOut	Invoked when a request is received on the RemoteSignOutPath.
OnSignedOutCallbackRedirect	Invoked before redirecting to the SignedOutRedirectUri at the end of a remote sign-out flow.
OnTicketReceived	Invoked after the remote ticket has been received. (Inherited from RemoteAuthenticationEvents)
OnTokenResponseReceived	Invoked after "authorization code" is redeemed for tokens at the token endpoint.
OnTokenValidated	Invoked when an IdToken has been validated and produced an AuthenticationTicket. Note there are additional checks after this event that validate other aspects of the authentication flow like the nonce.
OnUserInformationReceived	Invoked when user information is retrieved from the UserInfoEndpoint.

Methods

AccessDenied(AccessDeniedContext)	Invoked when an access denied error was returned by the remote server. (Inherited from RemoteAuthenticationEvents)
AuthenticationFailed(AuthenticationFailedContext)	Invoked if exceptions are thrown during request processing. The exceptions will be re-thrown after this event unless suppressed.
AuthorizationCodeReceived(AuthorizationCodeReceivedContext)	Invoked if an authorization code is present in the protocol message.
MessageReceived(MessageReceivedContext)	Invoked when a protocol message is first received.
RedirectToIdentityProvider(RedirectContext)	Invoked before redirecting to the identity provider to authenticate. This can be used to set ProtocolMessage.State that will be persisted through the authentication process. The ProtocolMessage can also be used to add or customize parameters sent to the identity provider.
RedirectToIdentityProviderForSignOut(RedirectContext)	Invoked before redirecting to the identity provider to sign out.
RemoteFailure(FailureContext)	Invoked when there is a remote failure (Inherited from RemoteAuthenticationEvents)
RemoteFailure(RemoteFailureContext)	Invoked when there is a remote failure. (Inherited from RemoteAuthenticationEvents)
RemoteSignOut(RemoteSignOutContext)	Invoked when a request is received on the RemoteSignOutPath.
SignedOutCallbackRedirect(RemoteSignOutContext)	Invoked before redirecting to the SignedOutRedirectUri at the end of a remote sign-out flow.
TicketReceived(TicketReceivedContext)	Invoked after the remote ticket has been received. (Inherited from RemoteAuthenticationEvents)
TokenResponseReceived(TokenResponseReceivedContext)	Invoked after an authorization code is redeemed for tokens at the token endpoint.
TokenValidated(TokenValidatedContext)	Invoked when an IdToken has been validated and produced an AuthenticationTicket. Note there are additional checks after this event that validate other aspects of the authentication flow like the nonce.
UserInformationReceived(UserInformationReceivedContext)	Invoked when user information is retrieved from the UserInfoEndpoint.

Applies to

OpenIdConnectEvents Class

Definition

Constructors

Properties

Methods

Applies to

Feedback

Feedback

Additional resources