This documentation is archived and is not being maintained.

FormsIdentity Class

Represents a user identity authenticated using forms authentication. This class cannot be inherited.

System.Object
  System.Web.Security.FormsIdentity

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

[<SerializableAttribute>]
type FormsIdentity =  
    class
        interface IIdentity
    end

The FormsIdentity type exposes the following members.

  NameDescription
Public methodFormsIdentityInitializes a new instance of the FormsIdentity class.
Top

  NameDescription
Public propertyAuthenticationTypeGets the type of authenticated identity.
Public propertyIsAuthenticatedGets a value that indicates whether authentication took place.
Public propertyNameGets the user name of the forms identity.
Public propertyTicketGets the FormsAuthenticationTicket for the forms-authentication user identity.
Top

  NameDescription
Public methodEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

The FormsIdentity class is used by the FormsAuthenticationModule when a user is authenticated with forms authentication. An instance of the FormsIdentity class is created using the FormsAuthenticationTicket that is decrypted from the forms-authentication cookie or from the URL. The new instance of the FormsIdentity class is used to construct a new GenericPrincipal object that is set as the value of the User property for the current HttpContext.

The following code example generates a FormsAuthenticationTicket and then uses it to create an instance of the FormsIdentity class, based on whether the user supplies the correct user name and password on the form.

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

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0, 1.1, 1.0

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

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