FormsAuthenticationUser Class

.NET Framework (current version)

Other Versions

Configures the user's credentials for Web applications that use forms-based authentication.

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

Inheritance Hierarchy

System::Object
System.Configuration::ConfigurationElement
System.Web.Configuration::FormsAuthenticationUser

Syntax

C++

public ref class FormsAuthenticationUser sealed : ConfigurationElement

Constructors

	Name	Description
	FormsAuthenticationUser(String^, String^)	This API supports the product infrastructure and is not intended to be used directly from your code. Initializes a new instance of the FormsAuthenticationUser class using the passed parameters.

Properties

	Name	Description
	CurrentConfiguration	Gets a reference to the top-level Configuration instance that represents the configuration hierarchy that the current ConfigurationElement instance belongs to.(Inherited from ConfigurationElement.)
	ElementInformation	Gets an ElementInformation object that contains the non-customizable information and functionality of the ConfigurationElement object. (Inherited from ConfigurationElement.)
	ElementProperty	Gets the ConfigurationElementProperty object that represents the ConfigurationElement object itself.(Inherited from ConfigurationElement.)
	Item[ConfigurationProperty^]	Gets or sets a property or attribute of this configuration element.(Inherited from ConfigurationElement.)
	Item[String^]	Gets or sets a property, attribute, or child element of this configuration element.(Inherited from ConfigurationElement.)
	LockAllAttributesExcept	Gets the collection of locked attributes.(Inherited from ConfigurationElement.)
	LockAllElementsExcept	Gets the collection of locked elements.(Inherited from ConfigurationElement.)
	LockAttributes	Gets the collection of locked attributes (Inherited from ConfigurationElement.)
	LockElements	Gets the collection of locked elements.(Inherited from ConfigurationElement.)
	LockItem	Gets or sets a value indicating whether the element is locked.(Inherited from ConfigurationElement.)
	Name	Gets or sets the logon user name.
	Password	Gets or sets the user's password.
	Properties	Gets the collection of properties.(Inherited from ConfigurationElement.)

Methods

	Name	Description
	DeserializeElement(XmlReader^, Boolean)	Reads XML from the configuration file.(Inherited from ConfigurationElement.)
	Equals(Object^)	Compares the current ConfigurationElement instance to the specified object.(Inherited from ConfigurationElement.)
	GetHashCode()	Gets a unique value representing the current ConfigurationElement instance.(Inherited from ConfigurationElement.)
	GetType()	Gets the Type of the current instance.(Inherited from Object.)
	Init()	Sets the ConfigurationElement object to its initial state.(Inherited from ConfigurationElement.)
	InitializeDefault()	Used to initialize a default set of values for the ConfigurationElement object.(Inherited from ConfigurationElement.)
	IsModified()	Indicates whether this configuration element has been modified since it was last saved or loaded, when implemented in a derived class.(Inherited from ConfigurationElement.)
	IsReadOnly()	Gets a value indicating whether the ConfigurationElement object is read-only.(Inherited from ConfigurationElement.)
	Reset(ConfigurationElement^)	Resets the internal state of the ConfigurationElement object, including the locks and the properties collections.(Inherited from ConfigurationElement.)
	ResetModified()	Resets the value of the IsModified method to false when implemented in a derived class.(Inherited from ConfigurationElement.)
	SerializeElement(XmlWriter^, Boolean)	Writes the contents of this configuration element to the configuration file when implemented in a derived class.(Inherited from ConfigurationElement.)
	SerializeToXmlElement(XmlWriter^, String^)	Writes the outer tags of this configuration element to the configuration file when implemented in a derived class.(Inherited from ConfigurationElement.)
	SetReadOnly()	Sets the IsReadOnly property for the ConfigurationElement object and all subelements.(Inherited from ConfigurationElement.)
	ToString()	Returns a string that represents the current object.(Inherited from Object.)
	Unmerge(ConfigurationElement^, ConfigurationElement^, ConfigurationSaveMode)	Modifies the ConfigurationElement object to remove all values that should not be saved. (Inherited from ConfigurationElement.)

Remarks

The FormsAuthenticationUser class provides a way to programmatically access and modify the section of a configuration file.

This type is part of a group that includes the FormsAuthenticationCredentials, the FormsAuthenticationUserCollection, and the FormsAuthenticationConfiguration types. The types other than the collection type directly affect the underlying configuration tags.

Note
The FormsAuthenticationUser can write information into the related section of the configuration file at machine, site, or application level only. Any attempt to write in a configuration file at a different level in the hierarchy will result in an error message generated by the parser. However, you can use this class to read configuration information at any level in the hierarchy. For safety and scalability, it is recommended that you use an external repository, such as a database, to keep the users' credentials.

Note

The FormsAuthenticationUser can write information into the related section of the configuration file at machine, site, or application level only. Any attempt to write in a configuration file at a different level in the hierarchy will result in an error message generated by the parser. However, you can use this class to read configuration information at any level in the hierarchy. For safety and scalability, it is recommended that you use an external repository, such as a database, to keep the users' credentials.

Examples

The following code example shows how to obtain the FormsAuthenticationUserCollection to access the FormsAuthenticationUser objects of an existing Web application. The configuration file will contain a setup similar to the following.

Note
If you use the credentials Element for forms for authentication (ASP.NET Settings Schema) section, be sure to follow the guidelines explained at ASP.NET Authentication. For scalability and better security, it is recommended you use an external database to store the users' credentials. For more information about building secure ASP.NET applications, search the Microsoft MSDN Web site (msdn.microsoft.com) for "Securing Your ASP.NET Application" and "Building Secure ASP.NET Applications: Authentication, Authorization, and Secure Communication."

Note

If you use the credentials Element for forms for authentication (ASP.NET Settings Schema) section, be sure to follow the guidelines explained at ASP.NET Authentication. For scalability and better security, it is recommended you use an external database to store the users' credentials. For more information about building secure ASP.NET applications, search the Microsoft MSDN Web site (msdn.microsoft.com) for "Securing Your ASP.NET Application" and "Building Secure ASP.NET Applications: Authentication, Authorization, and Secure Communication."

<authentication mode="Forms">
  <forms name="MyAppCookieName" loginUrl="/login.aspx">
    defaultUrl="formsdefault.aspx"
    protection="Encryption" timeout="5" path="aspnet"
    slidingExpiration="false"
    cookieless="UseCookies" domain="domainName">
    <credentials passwordFormat="SHA1">
      <user name="aspnetuser1"
        password="5BAA61E4C9B93F3F0682250B6CF8331B7EE68FD8"/>
       <user name="aspnetuser2"
         password="E38AD214943DAAD1D64C102FAEC29DE4AFE9DA3D"/>
    </credentials>          
  </forms>
</authentication>

C++

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

Version Information

.NET Framework
Available since 2.0

Thread Safety

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