|
Authentication
|
Represents options for authentication using AuthenticationHandler.
Inheritance Hierarchy
SystemObject
GSF.Web.SecurityAuthenticationOptions
GSF.Web.SecurityAuthenticationOptions
Namespace: GSF.Web.Security
Assembly: GSF.Web (in GSF.Web.dll) Version: 2.4.257-beta
SyntaxThe AuthenticationOptions type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | AuthenticationOptions | Creates a new instance of the AuthenticationOptions class. |
Properties| Name | Description | |
|---|---|---|
 | AjaxRequestVerificationToken | Gets or sets token to specify when using AJAX for request verification tokens. |
| AlternateSecurityProviderResourceExpression | Gets or sets the expression that will match paths for the resources on the web server that should user the Alternate SecurityProvider. |
| AnonymousResourceExpression | Gets or sets the expression that will match paths for the resources on the web server that can be provided without checking credentials. |
| AuthenticationSchemes | Gets or sets the authentication schemes to use when testing authentication with the AuthTestPage. |
| AuthenticationToken | Gets or sets the token used for identifying the authentication token in cookie headers. |
| AuthFailureRedirectResourceExpression | 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. |
| AuthTestPage | Gets or sets the page name used to test user authorization. |
| ClearCredentialsParameter | 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. |
| LoginHeader | Gets or sets any custom header to be displayed on the LoginPage. |
| LoginPage | Gets or sets the login page used as a redirect location when authentication fails. |
| LogoutPage | Gets or sets the path for the logout page. |
| Readonly | Gets an immutable version of the authentication options. |
| Realm | Gets or sets the case-sensitive identifier that defines the protection space for this authentication. |
| RequestVerificationToken | Gets or sets the token used for anti-forgery verification in HTTP request headers. |
| SessionToken | Gets or sets the token used for identifying the session ID in cookie headers. |
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 a alternate securtityProvider resource. |
| IsAnonymousResource | Determines whether the given resource is an anonymous resource. |
| IsAuthFailureRedirectResource | Determines whether the given resource is an authentication failure redirect resource. |
 | ResourceRequiresAuthentication | Sets the resource to the required authentication state. |
| ToString | Returns a string that represents the current object. (Inherited from Object) |
Fields| Name | Description | |
|---|---|---|
 | DefaultAjaxRequestVerificationToken | Default value for AjaxRequestVerificationToken. |
| DefaultAlternateSecurityProviderResourceExpression | Default value for AlternateSecurityProviderResourceExpression. |
| DefaultAnonymousResourceExpression | Default value for AnonymousResourceExpression. |
| DefaultAuthenticationSchemes | Default value for AuthenticationSchemes. |
| DefaultAuthFailureRedirectResourceExpression | Default value for AuthFailureRedirectResourceExpression. |
| DefaultAuthTestPage | Default value for AuthTestPage. |
| DefaultClearCredentialsParameter | Default value for ClearCredentialsParameter. |
| DefaultLoginPage | Default value for LoginPage. |
| DefaultLogoutPage | Default value for LogoutPage. |
| DefaultRequestVerificationToken | Default value for RequestVerificationToken. |
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) |
See Also