IOAuthEvents Interface

Specifies callback methods which the Microsoft.AspNetCore.Authentication.OAuth.OAuthMiddleware`1 invokes to enable developer control over the authentication process.

Namespace
Microsoft.AspNetCore.Authentication.OAuth
Assemblies
  • Microsoft.AspNetCore.Authentication.OAuth

Syntax

public interface IOAuthEvents : IRemoteAuthenticationEvents
interface Microsoft.AspNetCore.Authentication.OAuth.IOAuthEvents

Methods

CreatingTicket(Microsoft.AspNetCore.Authentication.OAuth.OAuthCreatingTicketContext)

Invoked after the provider successfully authenticates a user. This can be used to retrieve user information. This event may not be invoked by sub-classes of OAuthAuthenticationHandler if they override CreateTicketAsync.

Arguments:context (Microsoft.AspNetCore.Authentication.OAuth.OAuthCreatingTicketContext) – Contains information about the login session.
Return type:System.Threading.Tasks.Task
Returns:A System.Threading.Tasks.Task representing the completed operation. 
Task CreatingTicket(OAuthCreatingTicketContext context)
RedirectToAuthorizationEndpoint(Microsoft.AspNetCore.Authentication.OAuth.OAuthRedirectToAuthorizationContext)

Called when a Challenge causes a redirect to the authorize endpoint.

Arguments:context (Microsoft.AspNetCore.Authentication.OAuth.OAuthRedirectToAuthorizationContext) – Contains redirect URI and Microsoft.AspNetCore.Http.Authentication.AuthenticationProperties of the challenge.
Return type:System.Threading.Tasks.Task 
Task RedirectToAuthorizationEndpoint(OAuthRedirectToAuthorizationContext context)