AuthenticationOptions Class

Base Options for all authentication middleware.

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

Syntax

public abstract class AuthenticationOptions
class Microsoft.AspNetCore.Builder.AuthenticationOptions

Properties

Microsoft.AspNetCore.Builder.AuthenticationOptions.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.

Return type:System.String
public string AuthenticationScheme { get; set; }
Microsoft.AspNetCore.Builder.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.

Return type:System.Boolean
public bool AutomaticAuthenticate { get; set; }
Microsoft.AspNetCore.Builder.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.

Return type:System.Boolean
public bool AutomaticChallenge { get; set; }
Microsoft.AspNetCore.Builder.AuthenticationOptions.ClaimsIssuer

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

Return type:System.String
public string ClaimsIssuer { get; set; }
Microsoft.AspNetCore.Builder.AuthenticationOptions.Description

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

Return type:Microsoft.AspNetCore.Http.Authentication.AuthenticationDescription
public AuthenticationDescription Description { get; set; }