OAuthOptions OAuthOptions OAuthOptions Class

Definition

Configuration options OAuth.

public class OAuthOptions : Microsoft.AspNetCore.Authentication.RemoteAuthenticationOptions
type OAuthOptions = class
    inherit RemoteAuthenticationOptions
Public Class OAuthOptions
Inherits RemoteAuthenticationOptions
Inheritance
Derived

Constructors

OAuthOptions() OAuthOptions() OAuthOptions()

Properties

AuthorizationEndpoint AuthorizationEndpoint AuthorizationEndpoint

Gets or sets the URI where the client will be redirected to authenticate.

Backchannel Backchannel Backchannel

Used to communicate with the remote identity provider.

(Inherited from RemoteAuthenticationOptions)
BackchannelHttpHandler BackchannelHttpHandler BackchannelHttpHandler

The HttpMessageHandler used to communicate with remote identity provider. This cannot be set at the same time as BackchannelCertificateValidator unless the value can be downcast to a WebRequestHandler.

(Inherited from RemoteAuthenticationOptions)
BackchannelTimeout BackchannelTimeout BackchannelTimeout

Gets or sets timeout value in milliseconds for back channel communications with the remote identity provider.

(Inherited from RemoteAuthenticationOptions)
CallbackPath CallbackPath CallbackPath

The request path within the application's base path where the user-agent will be returned. The middleware will process this request when it arrives.

(Inherited from RemoteAuthenticationOptions)
ClaimActions ClaimActions ClaimActions

A collection of claim actions used to select values from the json user data and create Claims.

ClaimsIssuer ClaimsIssuer ClaimsIssuer

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

(Inherited from AuthenticationSchemeOptions)
ClientId ClientId ClientId

Gets or sets the provider-assigned client id.

ClientSecret ClientSecret ClientSecret

Gets or sets the provider-assigned client secret.

CorrelationCookie CorrelationCookie CorrelationCookie

Determines the settings used to create the correlation cookie before the cookie gets added to the response.

(Inherited from RemoteAuthenticationOptions)
DataProtectionProvider DataProtectionProvider DataProtectionProvider

Gets or sets the type used to secure data.

(Inherited from RemoteAuthenticationOptions)
Events Events Events

Gets or sets the OAuthEvents used to handle authentication events.

EventsType EventsType EventsType

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

(Inherited from AuthenticationSchemeOptions)
ForwardAuthenticate ForwardAuthenticate ForwardAuthenticate

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.

(Inherited from AuthenticationSchemeOptions)
ForwardChallenge ForwardChallenge ForwardChallenge

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.

(Inherited from AuthenticationSchemeOptions)
ForwardDefault ForwardDefault ForwardDefault

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.

(Inherited from AuthenticationSchemeOptions)
ForwardDefaultSelector ForwardDefaultSelector ForwardDefaultSelector

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.

(Inherited from AuthenticationSchemeOptions)
ForwardForbid ForwardForbid ForwardForbid

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.

(Inherited from AuthenticationSchemeOptions)
ForwardSignIn ForwardSignIn ForwardSignIn

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.

(Inherited from AuthenticationSchemeOptions)
ForwardSignOut ForwardSignOut ForwardSignOut

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

(Inherited from AuthenticationSchemeOptions)
RemoteAuthenticationTimeout RemoteAuthenticationTimeout RemoteAuthenticationTimeout

Gets or sets the time limit for completing the authentication flow (15 minutes by default).

(Inherited from RemoteAuthenticationOptions)
SaveTokens SaveTokens SaveTokens

Defines whether access and refresh tokens should be stored in the AuthenticationProperties after a successful authorization. This property is set to false by default to reduce the size of the final authentication cookie.

(Inherited from RemoteAuthenticationOptions)
Scope Scope Scope

Gets the list of permissions to request.

SignInScheme SignInScheme SignInScheme

Gets or sets the authentication scheme corresponding to the middleware responsible of persisting user's identity after a successful authentication. This value typically corresponds to a cookie middleware registered in the Startup class. When omitted, DefaultSignInScheme is used as a fallback value.

(Inherited from RemoteAuthenticationOptions)
StateDataFormat StateDataFormat StateDataFormat

Gets or sets the type used to secure data handled by the middleware.

TokenEndpoint TokenEndpoint TokenEndpoint

Gets or sets the URI the middleware will access to exchange the OAuth token.

UserInformationEndpoint UserInformationEndpoint UserInformationEndpoint

Gets or sets the URI the middleware will access to obtain the user information. This value is not used in the default implementation, it is for use in custom implementations of IOAuthAuthenticationEvents.Authenticated or OAuthAuthenticationHandler.CreateTicketAsync.

Methods

Validate() Validate() Validate()

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

Validate(String) Validate(String) Validate(String)

Checks that the options are valid for a specific scheme

(Inherited from RemoteAuthenticationOptions)

Applies to