Click or drag to resize

AuthenticationOptions Class

Represents options for authentication using AuthenticationHandler.
Inheritance Hierarchy
SystemObject
  AuthenticationOptions
    GSF.Web.SecurityAuthenticationOptions

Namespace: GSF.Web.Security
Assembly: GSF.Web (in GSF.Web.dll) Version: 2.4.207-beta
Syntax
public sealed class AuthenticationOptions : AuthenticationOptions
View Source

The AuthenticationOptions type exposes the following members.

Constructors
 NameDescription
Public methodAuthenticationOptions Creates a new instance of the AuthenticationOptions class.
Top
Properties
 NameDescription
Public propertyAjaxRequestVerificationToken Gets or sets token to specify when using AJAX for request verification tokens.
Public propertyAlternateSecurityProviderResourceExpression Gets or sets the expression that will match paths for the resources on the web server that should user the Alternate SecurityProvider.
Public propertyAnonymousResourceExpression Gets or sets the expression that will match paths for the resources on the web server that can be provided without checking credentials.
Public propertyAuthenticationMode If Active the authentication middleware alter the request user coming in and alter 401 Unauthorized responses going out. If Passive the authentication middleware will only provide identity and alter responses when explicitly indicated by the AuthenticationType.
(Inherited from AuthenticationOptions)
Public propertyAuthenticationSchemes Gets or sets the authentication schemes to use when testing authentication with the AuthTestPage.
Public propertyAuthenticationToken Gets or sets the token used for identifying the authentication token in cookie headers.
Public propertyAuthenticationType The AuthenticationType in the options corresponds to the IIdentity AuthenticationType property. A different value may be assigned in order to use the same authentication middleware type more than once in a pipeline.
(Inherited from AuthenticationOptions)
Public propertyAuthFailureRedirectResourceExpression Gets or sets the expression that will match paths for the resources on the web server that should redirect to the LoginPage when authentication fails.
Public propertyAuthTestPage Gets or sets the page name used to test user authorization.
Public propertyClearCredentialsParameter Gets or sets the parameter name for the AuthTestPage that forces it to use Basic authentication so that any cached browser credentials can be cleared.
Public propertyDescription Additional information about the authentication type which is made available to the application.
(Inherited from AuthenticationOptions)
Public propertyLoginHeader Gets or sets any custom header to be displayed on the LoginPage.
Public propertyLoginPage Gets or sets the login page used as a redirect location when authentication fails.
Public propertyLogoutPage Gets or sets the path for the logout page.
Public propertyReadonly Gets an immutable version of the authentication options.
Public propertyRealm Gets or sets the case-sensitive identifier that defines the protection space for this authentication.
Public propertyRequestVerificationToken Gets or sets the token used for anti-forgery verification in HTTP request headers.
Public propertySessionToken Gets or sets the token used for identifying the session ID in cookie headers.
Top
Methods
 NameDescription
Public methodEqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
Public methodGetHashCodeServes as the default hash function.
(Inherited from Object)
Public methodGetTypeGets the Type of the current instance.
(Inherited from Object)
Public methodIsAlternateSecurityProviderResource Determines whether the given resource is a alternate securtityProvider resource.
Public methodIsAnonymousResource Determines whether the given resource is an anonymous resource.
Public methodIsAuthFailureRedirectResource Determines whether the given resource is an authentication failure redirect resource.
Public methodStatic memberResourceRequiresAuthentication Sets the resource to the required authentication state.
Public methodToStringReturns a string that represents the current object.
(Inherited from Object)
Top
Fields
Extension Methods
 NameDescription
Public Extension MethodGetEnumValueOrDefault Gets the enumeration constant for value, if defined in the enumeration, or a default value.
(Defined by EnumExtensions)
Public Extension MethodGetEnumValueOrDefaultT Gets the enumeration constant for this value, if defined in the enumeration, or a default value.
(Defined by EnumExtensions)
Public Extension MethodGetFullAuthTestPath Gets full path to AuthTestPage, evaluating leading ~ character as the given base path.
(Defined by AuthenticationOptionsExtensions)
Public Extension MethodGetFullLoginPath Gets full path to LoginPage, evaluating leading ~ character as the given base path.
(Defined by AuthenticationOptionsExtensions)
Public Extension MethodGetFullLogoutPath Gets full path to LogoutPage, evaluating leading ~ character as the given base path.
(Defined by AuthenticationOptionsExtensions)
Top
See Also