ReadonlyAuthenticationOptions Class

Represents an immutable version of AuthenticationOptions.

Inheritance Hierarchy

SystemObject
GSF.Web.SecurityReadonlyAuthenticationOptions

Namespace: GSF.Web.Security
Assembly: GSF.Web (in GSF.Web.dll) Version: 2.4.230-beta

Syntax

C++

JavaScript

Copy

public sealed class ReadonlyAuthenticationOptions

Public NotInheritable Class ReadonlyAuthenticationOptions

public ref class ReadonlyAuthenticationOptions sealed

[<SealedAttribute>]
type ReadonlyAuthenticationOptions = class end

GSF.Web.Security.ReadonlyAuthenticationOptions = function();

Type.createClass(
	'GSF.Web.Security.ReadonlyAuthenticationOptions');

View Source

The ReadonlyAuthenticationOptions type exposes the following members.

Properties

	Name	Description
	AjaxRequestVerificationToken	Gets token to specify when using AJAX for request verification tokens.
	AlternateSecurityProviderResourceExpression	Gets the expression that will match paths for the resources on the web server that should use the alternate SecurityProvider.
	AnonymousResourceExpression	Gets the expression that will match paths for the resources on the web server that can be provided without checking credentials.
	AuthenticationSchemes	Gets the authentication schemes to use when testing authentication with the AuthTestPage.
	AuthenticationToken	Gets the token used for identifying the authentication token in cookie headers.
	AuthFailureRedirectResourceExpression	Gets the expression that will match paths for the resources on the web server that should redirect to the LoginPage when authentication fails.
	AuthTestPage	Gets the page name used to test user authorization.
	ClearCredentialsParameter	Gets the parameter name for the AuthTestPage that forces it to use Basic authentication so that any cached browser credentials can be cleared.
	LoginHeader	Gets any custom header to be displayed on the LoginPage.
	LoginPage	Gets the login page used as a redirect location when authentication fails.
	LogoutPage	Gets the path for the logout page.
	Realm	Gets the case-sensitive identifier that defines the protection space for this authentication.
	RequestVerificationToken	Gets the token used for anti-forgery verification in HTTP request headers.
	SessionToken	Gets the token used for identifying the session ID in cookie headers.

Top

Methods

	Name	Description
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object)
	GetHashCode	Serves as the default hash function. (Inherited from Object)
	GetType	Gets the Type of the current instance. (Inherited from Object)
	IsAlternateSecurityProviderResource	Determines whether the given resource is using the alternate SecuityProvider.
	IsAnonymousResource	Determines whether the given resource is an anonymous resource.
	IsAuthFailureRedirectResource	Determines whether the given resource is an authentication failure redirect resource.
	ToString	Returns a string that represents the current object. (Inherited from Object)

Top

Extension Methods

	Name	Description
	GetEnumValueOrDefault	Gets the enumeration constant for value, if defined in the enumeration, or a default value. (Defined by EnumExtensions)
	GetEnumValueOrDefaultT	Gets the enumeration constant for this value, if defined in the enumeration, or a default value. (Defined by EnumExtensions)
	GetFullAuthTestPath	Gets full path to AuthTestPage, evaluating leading ~ character as the given base path. (Defined by AuthenticationOptionsExtensions)
	GetFullLoginPath	Gets full path to LoginPage, evaluating leading ~ character as the given base path. (Defined by AuthenticationOptionsExtensions)
	GetFullLogoutPath	Gets full path to LogoutPage, evaluating leading ~ character as the given base path. (Defined by AuthenticationOptionsExtensions)

Top

Reference

GSF.Web.Security Namespace