Share via


OAuthOptions Class

Definition

Configuration options for OAuthMiddleware<TOptions>.

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

Constructors

OAuthOptions()

Properties

AuthenticationScheme

The AuthenticationScheme in the options corresponds to the logical name for a particular authentication scheme. A different value may be assigned in order to use the same authentication middleware type more than once in a pipeline.

(Inherited from AuthenticationOptions)
AuthorizationEndpoint

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

AutomaticAuthenticate

If true the authentication middleware alter the request user coming in. If false the authentication middleware will only provide identity when explicitly indicated by the AuthenticationScheme.

(Inherited from AuthenticationOptions)
AutomaticChallenge

If true the authentication middleware should handle automatic challenge. If false the authentication middleware will only alter responses when explicitly indicated by the AuthenticationScheme.

(Inherited from AuthenticationOptions)
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

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

(Inherited from RemoteAuthenticationOptions)
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)
ClaimsIssuer

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

(Inherited from AuthenticationOptions)
ClientId

Gets or sets the provider-assigned client id.

ClientSecret

Gets or sets the provider-assigned client secret.

Description

Additional information about the authentication type which is made available to the application.

(Inherited from AuthenticationOptions)
DisplayName

Get or sets the text that the user can display on a sign in user interface.

(Inherited from RemoteAuthenticationOptions)
Events

Gets or sets the IOAuthEvents used to handle authentication events.

RemoteAuthenticationTimeout

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

(Inherited from RemoteAuthenticationOptions)
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

Gets the list of permissions to request.

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, SignInScheme is used as a fallback value.

(Inherited from RemoteAuthenticationOptions)
StateDataFormat

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

SystemClock

For testing purposes only.

SystemClock

For testing purposes only.

(Inherited from AuthenticationOptions)
TokenEndpoint

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

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.

Applies to