Note

Access to this page requires authorization. You can try signing in or .

Access to this page requires authorization. You can try .

OAuthCreatingTicketContext Class

Definition

Namespace:
Microsoft.AspNetCore.Authentication.OAuth
Assembly:
Microsoft.AspNetCore.Authentication.OAuth.dll
Package:
Microsoft.AspNetCore.Authentication.OAuth v1.0.0
Package:
Microsoft.AspNetCore.Authentication.OAuth v1.1.0
Package:
Microsoft.AspNetCore.App.Ref v10.0.0
Package:
Microsoft.AspNetCore.App.Ref v11.0.0-preview.4.26230.115
Package:
Microsoft.AspNetCore.Authentication.OAuth v2.0.0
Package:
Microsoft.AspNetCore.Authentication.OAuth v2.1.0
Package:
Microsoft.AspNetCore.Authentication.OAuth v2.2.0
Package:
Microsoft.AspNetCore.App.Ref v3.0.1
Package:
Microsoft.AspNetCore.App.Ref v3.1.10
Package:
Microsoft.AspNetCore.App.Ref v5.0.0
Package:
Microsoft.AspNetCore.App.Ref v6.0.36
Package:
Microsoft.AspNetCore.App.Ref v7.0.5
Package:
Microsoft.AspNetCore.App.Ref v8.0.19
Package:
Microsoft.AspNetCore.App.Ref v9.0.8
Source:
OAuthCreatingTicketContext.cs
Source:
OAuthCreatingTicketContext.cs
Source:
OAuthCreatingTicketContext.cs

Important

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.

Contains information about the login session as well as the user ClaimsIdentity.

public ref class OAuthCreatingTicketContext : Microsoft::AspNetCore::Authentication::BaseContext
public ref class OAuthCreatingTicketContext : Microsoft::AspNetCore::Authentication::ResultContext<Microsoft::AspNetCore::Authentication::OAuth::OAuthOptions ^>
public class OAuthCreatingTicketContext : Microsoft.AspNetCore.Authentication.BaseContext
public class OAuthCreatingTicketContext : Microsoft.AspNetCore.Authentication.ResultContext<Microsoft.AspNetCore.Authentication.OAuth.OAuthOptions>
type OAuthCreatingTicketContext = class
 inherit BaseContext
type OAuthCreatingTicketContext = class
 inherit ResultContext<OAuthOptions>
Public Class OAuthCreatingTicketContext
Inherits BaseContext
Public Class OAuthCreatingTicketContext
Inherits ResultContext(Of OAuthOptions)
Inheritance
OAuthCreatingTicketContext
Inheritance

Constructors

Name Description
OAuthCreatingTicketContext(AuthenticationTicket, HttpContext, OAuthOptions, HttpClient, OAuthTokenResponse, JObject)

Initializes a new OAuthCreatingTicketContext.
OAuthCreatingTicketContext(AuthenticationTicket, HttpContext, OAuthOptions, HttpClient, OAuthTokenResponse)

Initializes a new OAuthCreatingTicketContext.
OAuthCreatingTicketContext(ClaimsPrincipal, AuthenticationProperties, HttpContext, AuthenticationScheme, OAuthOptions, HttpClient, OAuthTokenResponse, JObject)

Initializes a new OAuthCreatingTicketContext.
OAuthCreatingTicketContext(ClaimsPrincipal, AuthenticationProperties, HttpContext, AuthenticationScheme, OAuthOptions, HttpClient, OAuthTokenResponse, JsonElement)

Initializes a new OAuthCreatingTicketContext.
OAuthCreatingTicketContext(ClaimsPrincipal, AuthenticationProperties, HttpContext, AuthenticationScheme, OAuthOptions, HttpClient, OAuthTokenResponse)

Initializes a new OAuthCreatingTicketContext.

Properties

Name Description
AccessToken

Gets the access token provided by the authentication service.
Backchannel

Gets the backchannel used to communicate with the provider.
ExpiresIn

Gets the access token expiration time.
HttpContext (Inherited from BaseContext)
HttpContext

The context.

(Inherited from BaseContext<TOptions>)
Identity

Gets the main identity exposed by the authentication ticket. This property returns null when the ticket is null.
Options
Options

Gets the authentication options associated with the scheme.

(Inherited from BaseContext<TOptions>)
Principal

Gets or sets the ClaimsPrincipal containing the user claims.

(Inherited from ResultContext<TOptions>)
Properties

Gets or sets the AuthenticationProperties.

(Inherited from ResultContext<TOptions>)
RefreshToken

Gets the refresh token provided by the authentication service.
Request (Inherited from BaseContext)
Request

The request.

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

The response.

(Inherited from BaseContext<TOptions>)
Result

Gets the AuthenticateResult result.

(Inherited from ResultContext<TOptions>)
Scheme

The authentication scheme.

(Inherited from BaseContext<TOptions>)
Ticket

The AuthenticationTicket that will be created.
TokenResponse

Gets the token response returned by the authentication service.
TokenType

Gets the access token type provided by the authentication service.
User

Gets the JSON-serialized user or an empty JsonElement if it is not available.

Methods

Name Description
Fail(Exception)

Indicates that there was a failure during authentication.

(Inherited from ResultContext<TOptions>)
Fail(String)

Indicates that there was a failure during authentication.

(Inherited from ResultContext<TOptions>)
NoResult()

Indicates that there was no information returned for this authentication scheme.

(Inherited from ResultContext<TOptions>)
RunClaimActions()

Examines User, determine if the requisite data is present, and optionally add it to Identity.
RunClaimActions(JObject)
RunClaimActions(JsonElement)

Examines the specified userData, determine if the requisite data is present, and optionally add it to Identity.
Success()

Calls success creating a ticket with the Principal and Properties.

(Inherited from ResultContext<TOptions>)

Applies to

Feedback

Was this page helpful?