This documentation is archived and is not being maintained.

FormsAuthentication Members

FormsAuthentication overview

Public Constructors

public constructorFormsAuthentication Constructor Initializes a new instance of the FormsAuthentication class.

Public Properties

public propertystatic (Shared in Visual Basic)FormsCookieName Returns the configured cookie name used for the current application.
public propertystatic (Shared in Visual Basic)FormsCookiePath Returns the configured cookie path used for the current application.
public propertystatic (Shared in Visual Basic)RequireSSL Gets a value indicating whether the cookie must be transmitted using SSL (that is, over HTTPS only).
public propertystatic (Shared in Visual Basic)SlidingExpiration Gets a value indicating whether sliding expiration is enabled.

Public Methods

public methodstatic (Shared in Visual Basic)Authenticate Attempts to validate the credentials against those contained in the configured credential store, given the supplied credentials.
public methodstatic (Shared in Visual Basic)Decrypt Returns an instance of a FormsAuthenticationTicket class, given a valid encrypted authentication ticket obtained from an HTTP cookie.
public methodstatic (Shared in Visual Basic)Encrypt Produces a string containing an encrypted authentication ticket suitable for use in an HTTP cookie, given a FormsAuthenticationTicket.
public methodEquals (inherited from Object) Overloaded. Determines whether two Object instances are equal.
public methodstatic (Shared in Visual Basic)GetAuthCookie Overloaded. Creates an authentication cookie for a given user name.
public methodGetHashCode (inherited from Object) Serves as a hash function for a particular type, suitable for use in hashing algorithms and data structures like a hash table.
public methodstatic (Shared in Visual Basic)GetRedirectUrl Returns the redirect URL for the original request that caused the redirect to the logon page.
public methodGetType (inherited from Object) Gets the Type of the current instance.
public methodstatic (Shared in Visual Basic)HashPasswordForStoringInConfigFile Given a password and a string identifying the hash type, this routine produces a hash password suitable for storing in a configuration file.
public methodstatic (Shared in Visual Basic)Initialize Initializes FormsAuthentication by reading the configuration and getting the cookie values and encryption keys for the given application.
public methodstatic (Shared in Visual Basic)RedirectFromLoginPage Overloaded. Redirects an authenticated user back to the originally requested URL.
public methodstatic (Shared in Visual Basic)RenewTicketIfOld Conditionally updates the sliding expiration on a FormsAuthenticationTicket.
public methodstatic (Shared in Visual Basic)SetAuthCookie Overloaded. Creates an authentication ticket and attaches it to the cookie's collection of the outgoing response. It does not perform a redirect.
public methodstatic (Shared in Visual Basic)SignOut Removes the authentication ticket.
public methodToString (inherited from Object) Returns a String that represents the current Object.

Protected Methods

protected methodFinalize (inherited from Object) Overridden. Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.

In C# and C++, finalizers are expressed using destructor syntax.

protected methodMemberwiseClone (inherited from Object) Creates a shallow copy of the current Object.

See Also

FormsAuthentication Class | System.Web.Security Namespace