FormsAuthenticationUserCollection Class

Represents a collection of FormsAuthenticationUser objects. This class cannot be inherited.

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

[ConfigurationCollectionAttribute(typeof(FormsAuthenticationUser), AddItemName = "user", CollectionType = ConfigurationElementCollectionType.BasicMap)]
public sealed class FormsAuthenticationUserCollection : ConfigurationElementCollection

The FormsAuthenticationCredentials uses the FormsAuthenticationUserCollection to programmatically access and modify the users element of the credentials section in the forms section of the authorization configuration section.

This type is part of a group that includes the FormsAuthenticationConfiguration, the FormsAuthenticationCredentials, and the FormsAuthenticationUser types.

The following code example shows how to obtain the FormsAuthenticationUserCollection object from the configuration file of an existing Web application.

NoteNote:

If you use the credentials element 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."

// Get the Web application configuration.
System.Configuration.Configuration configuration = 
    WebConfigurationManager.OpenWebConfiguration("/aspnetTest");

// Get the authentication section.
AuthenticationSection authenticationSection = 
    (AuthenticationSection)configuration.GetSection(
    "system.web/authentication");

// Get the forms credentials collection .
FormsAuthenticationCredentials formsAuthenticationCredentials =
    authenticationSection.Forms.Credentials;

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

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

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

.NET Framework

Supported in: 3.5, 3.0, 2.0
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft