RemoteAuthenticationOptions Class

Contains the options used by the Microsoft.AspNetCore.Authentication.RemoteAuthenticationHandler`1.

Namespace
Microsoft.AspNetCore.Builder
Assemblies
  • Microsoft.AspNetCore.Authentication

Syntax

public class RemoteAuthenticationOptions : AuthenticationOptions
class Microsoft.AspNetCore.Builder.RemoteAuthenticationOptions

Properties

Microsoft.AspNetCore.Builder.RemoteAuthenticationOptions.BackchannelHttpHandler

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

Return type:System.Net.Http.HttpMessageHandler 
public HttpMessageHandler BackchannelHttpHandler { get; set; }
Microsoft.AspNetCore.Builder.RemoteAuthenticationOptions.BackchannelTimeout

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

Return type:System.TimeSpan
Returns:The back channel timeout. 
public TimeSpan BackchannelTimeout { get; set; }
Microsoft.AspNetCore.Builder.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.

Return type:Microsoft.AspNetCore.Http.PathString 
public PathString CallbackPath { get; set; }
Microsoft.AspNetCore.Builder.RemoteAuthenticationOptions.DisplayName

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

Return type:System.String 
public string DisplayName { get; set; }
Microsoft.AspNetCore.Builder.RemoteAuthenticationOptions.RemoteAuthenticationTimeout

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

Return type:System.TimeSpan 
public TimeSpan RemoteAuthenticationTimeout { get; set; }
Microsoft.AspNetCore.Builder.RemoteAuthenticationOptions.SaveTokens

Defines whether access and refresh tokens should be stored in the Microsoft.AspNetCore.Http.Authentication.AuthenticationProperties after a successful authorization. This property is set to <code>false</code> by default to reduce the size of the final authentication cookie.

Return type:System.Boolean 
public bool SaveTokens { get; set; }
Microsoft.AspNetCore.Builder.RemoteAuthenticationOptions.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, Microsoft.AspNetCore.Authentication.SharedAuthenticationOptions.SignInScheme is used as a fallback value.

Return type:System.String 
public string SignInScheme { get; set; }

Fields

Events()
Return type:Microsoft.AspNetCore.Authentication.IRemoteAuthenticationEvents 
public IRemoteAuthenticationEvents Events