RemoteAuthenticationOptions Class

  • Reference

Definition

Namespace:
Microsoft.AspNetCore.Builder
Assembly:
Microsoft.AspNetCore.Authentication.dll
Package:
Microsoft.AspNetCore.Authentication v1.0.0
Package:
Microsoft.AspNetCore.Authentication v1.1.0

Contains the options used by the RemoteAuthenticationHandler<TOptions>.

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

Constructors

RemoteAuthenticationOptions()

Fields

Events

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)
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.
BackchannelTimeout

Gets or sets timeout value in milliseconds for back channel communications with the remote identity provider.
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.
ClaimsIssuer

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

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

Gets or sets the time limit for completing the authentication flow (15 minutes by default).
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.
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.
SystemClock

For testing purposes only.

(Inherited from AuthenticationOptions)

Applies to