FormsAuthenticationConfiguration.Credentials Property

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Gets the FormsAuthenticationCredentials collection of user names and passwords.

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

[ConfigurationPropertyAttribute("credentials")]
public FormsAuthenticationCredentials Credentials { get; }

Property Value

Type: System.Web.Configuration.FormsAuthenticationCredentials

A FormsAuthenticationCredentials collection that contains the user names and passwords.

The Credentials property gets the user names and passwords to use during forms-based authentication.

System_CAPS_noteNote

When security is required, you should use alternative ways of storing the user names and passwords; for example, in a database store. If you decide to use this collection, you should use the provided encryption facility.

The following code example shows how to access the Credentials property. Refer to the code example in the FormsAuthenticationConfiguration class topic to learn how to get the section.

// Get the current Credentials.
FormsAuthenticationCredentials currentCredentials = 
    formsAuthentication.Credentials;

StringBuilder credentials = new StringBuilder();
// Get all the credentials.
for (System.Int32 i = 0; i < currentCredentials.Users.Count; i++)
{
    credentials.Append("Name: " + 
        currentCredentials.Users[i].Name + 
        " Password: " + 
        currentCredentials.Users[i].Password);
    credentials.Append(Environment.NewLine);
}

.NET Framework
Available since 2.0
Return to top
Show: