FormsAuthenticationTicket Class

 

Provides access to properties and values of the ticket used with forms authentication to identify users. This class cannot be inherited.

Namespace:   System.Web.Security
Assembly:  System.Web (in System.Web.dll)

System.Object
  System.Web.Security.FormsAuthenticationTicket

[<Sealed>]
[<SerializableAttribute>]
type FormsAuthenticationTicket = class end

NameDescription
System_CAPS_pubmethodFormsAuthenticationTicket(Int32, String, DateTime, DateTime, Boolean, String)

Initializes a new instance of the FormsAuthenticationTicket class with cookie name, version, expiration date, issue date, persistence, and user-specific data. The cookie path is set to the default value established in the application's configuration file.

System_CAPS_pubmethodFormsAuthenticationTicket(Int32, String, DateTime, DateTime, Boolean, String, String)

Initializes a new instance of the FormsAuthenticationTicket class with cookie name, version, directory path, issue date, expiration date, persistence, and user-defined data.

System_CAPS_pubmethodFormsAuthenticationTicket(String, Boolean, Int32)

Initializes a new instance of the FormsAuthenticationTicket class using a cookie name and expiration information.

NameDescription
System_CAPS_pubpropertyCookiePath

Gets the cookie path for the forms-authentication ticket.

System_CAPS_pubpropertyExpiration

Gets the local date and time at which the forms-authentication ticket expires.

System_CAPS_pubpropertyExpired

Gets a value indicating whether the forms-authentication ticket has expired.

System_CAPS_pubpropertyIsPersistent

Gets a value indicating whether the cookie that contains the forms-authentication ticket information is persistent.

System_CAPS_pubpropertyIssueDate

Gets the local date and time at which the forms-authentication ticket was originally issued.

System_CAPS_pubpropertyName

Gets the user name associated with the forms-authentication ticket.

System_CAPS_pubpropertyUserData

Gets a user-specific string stored with the ticket.

System_CAPS_pubpropertyVersion

Gets the version number of the ticket.

NameDescription
System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Inherited from Object.)

The FormsAuthenticationTicket class is used to create an object that represents the authentication ticket that is used by forms authentication to identify an authenticated user. The properties and values of a forms-authentication ticket are converted to and from an encrypted string that is stored in a cookie or in the URL.

The FormsAuthentication class provides an Encrypt method to create a string value that can be stored in a cookie or in the URL from a FormsAuthenticationTicket. The FormsAuthentication class also provides a Decrypt method to create a FormsAuthenticationTicket object from the encrypted authentication ticket retrieved from the forms-authentication cookie or the URL.

The FormsAuthenticationTicket for the current authenticated user can be accessed using the Ticket property of the FormsIdentity class. You can access the current FormsIdentity object by casting the Identity property of the current User as type FormsIdentity.

The following code example stores the result of the Encrypt method in a cookie using the FormsCookieName and redirects the user to the URL returned from the GetRedirectUrl method.

System_CAPS_security Security Note

This example contains a text box that accepts user input, which is a potential security threat. By default, ASP.NET Web pages validate that user input does not include script or HTML elements. For more information, see Script Exploits Overview.

No code example is currently available or this language may not be supported.

.NET Framework
Available since 1.1

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show: