Home Library Learn Downloads Support Community
Sign in | United States - English | |
This topic has not yet been rated - Rate this topic

ActiveDirectoryMembershipUser Class

.NET Framework 4

Exposes and updates membership user information stored in an Active Directory data store.

System.Object
  System.Web.Security.MembershipUser
    System.Web.Security.ActiveDirectoryMembershipUser

Namespace:  System.Web.Security
Assembly:  System.Web (in System.Web.dll)
C#
C++
F#
VB
Copy 
[SerializableAttribute]
public class ActiveDirectoryMembershipUser : MembershipUser

The ActiveDirectoryMembershipUser type exposes the following members.

  Name Description
Protected method ActiveDirectoryMembershipUser() Initializes a new instance of an ActiveDirectoryMembershipUser object for a class that inherits the ActiveDirectoryMembershipUser class.
Public method ActiveDirectoryMembershipUser(String, String, Object, String, String, String, Boolean, Boolean, DateTime, DateTime, DateTime, DateTime, DateTime) Creates a new instance of the ActiveDirectoryMembershipUser class with the specified property values.
Top
  Name Description
Public property Comment Gets or sets application-specific information for the membership user. (Overrides MembershipUser.Comment.)
Public property CreationDate Gets the date and time when the user was added to the membership data store. (Inherited from MembershipUser.)
Public property Email Gets or sets the e-mail address of the membership user. (Overrides MembershipUser.Email.)
Public property IsApproved Gets or sets a value that indicates whether the membership user can be authenticated. (Overrides MembershipUser.IsApproved.)
Public property IsLockedOut Gets a value indicating whether the membership user is locked out and unable to be validated. (Inherited from MembershipUser.)
Public property IsOnline Gets whether the user is currently online. (Inherited from MembershipUser.)
Public property LastActivityDate Throws a NotSupportedException exception in all cases (Overrides MembershipUser.LastActivityDate.)
Public property LastLockoutDate Gets the most recent date and time that the membership user was locked out. (Inherited from MembershipUser.)
Public property LastLoginDate Throws a NotSupportedException exception in all cases. (Overrides MembershipUser.LastLoginDate.)
Public property LastPasswordChangedDate Gets the date and time when the membership user's password was last updated. (Inherited from MembershipUser.)
Public property PasswordQuestion Gets the password question for the membership user. (Inherited from MembershipUser.)
Public property ProviderName Gets the name of the membership provider that stores and retrieves user information for the membership user. (Inherited from MembershipUser.)
Public property ProviderUserKey Gets the user identifier from the Active Directory data store for the membership user. (Overrides MembershipUser.ProviderUserKey.)
Public property UserName Gets the logon name of the membership user. (Inherited from MembershipUser.)
Top
  Name Description
Public method ChangePassword Updates the password for the membership user in the membership data store. (Inherited from MembershipUser.)
Public method ChangePasswordQuestionAndAnswer Updates the password question and answer for the membership user in the membership data store. (Inherited from MembershipUser.)
Public method Equals(Object) Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetPassword() Gets the password for the membership user from the membership data store. (Inherited from MembershipUser.)
Public method GetPassword(String) Gets the password for the membership user from the membership data store. (Inherited from MembershipUser.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method ResetPassword() Resets a user's password to a new, automatically generated password. (Inherited from MembershipUser.)
Public method ResetPassword(String) Resets a user's password to a new, automatically generated password. (Inherited from MembershipUser.)
Public method ToString Returns the user name for the membership user. (Inherited from MembershipUser.)
Public method UnlockUser Clears the locked-out state of the user so that the membership user can be validated. (Inherited from MembershipUser.)
Top

The ActiveDirectoryMembershipUser object is used to represent a single membership user in the Active Directory membership data store. It exposes information about the membership user such as the e-mail address, and provides functionality for the membership user such as the ability to change or reset his or her password.

An ActiveDirectoryMembershipUser object is returned by the application's membership provider whenever the application is configured to use an Active Directory data store. In an application that can be configured to use different data stores, or in an application that uses multiple data stores, you can refer to the base class, MembershipUser. Because the ActiveDirectoryMembershipUser object does not implement the LastActivityDate and LastLoginDate properties, you must be prepared to handle the NotSupportedException that is thrown when these members are accessed on an ActiveDirectoryMembershipUser object.

The ActiveDirectoryMembershipUser class implements internal optimizations used by the ActiveDirectoryMembershipProvider class to minimize the number of attribute updates that occur when calling the UpdateUser method. It also serializes the SecurityIdentifier representation (available in the ProviderUserKey property) so that an ActiveDirectoryMembershipUser object can be serialized and deserialized without throwing exceptions.

A ActiveDirectoryMembershipUser object is returned by the GetUser and CreateUser methods or as part of a MembershipUserCollection returned by the GetAllUsers, FindUsersByName, and FindUsersByEmail methods.

An ActiveDirectoryMembershipUser object is required by the UpdateUser method when you want to update the information for an existing membership user.

ActiveDirectoryMembershipUser properties are mapped to Active Directory attributes. The following table lists the ActiveDirectoryMembershipUser properties and their default attribute mappings.

Property

Default directory attribute

Can be mapped?

ProviderUserKey

securityIdentifier

No

UserName

userPrincipalName

Yes, but must be either userPrincipalName or sAMAccountName

Comment

comment

No

CreationDate

whenCreated

No

Email

mail

Yes, but must be a single-valued attribute of type Unicode String.

LastActivityDate

n/a

Not supported by ActiveDirectoryMembershipProvider.

LastLoginDate

n/a

Not supported by ActiveDirectoryMembershipProvider.

LastPasswordChangedDate

pwdLastSet

No

PasswordQuestion

none, but must be mapped to an attribute if using question-and-answer security for password reset or retrieval.

Yes, but must be a single-valued attribute of type Unicode String.

IsApproved

User-Account-Control (AD)

mDS-UserAccountDisabled (ADAM)

No

IsLockedOut

computed from lockoutTime and the AD lockout duration (AD on Windows 2000)

msDS-User-Account-Control-Computed (AD on Windows Server 2003)

msDS-User-Account-Control-Computed (ADAM)

No

LastLockoutDate

If locked out due to too many bad password attempts, the lockout time attribute is returned.

If locked out due to too many bad password answer attempts, the value stored in the attribute defined by attributeMapFailedPasswordAnswerLockoutTime is returned.

If locked out due to both a bad password and too many bad password attempts, the most recent date/time value is returned.

If the account is not locked out, return 1/1/1753 for SQL compatibility.

No

The following code example demonstrates using properties on the ActiveDirectoryMembershipUser object on a Web page that may return user information from multiple membership data stores. Because the ActiveDirectoryMembershipUser object that underlies the MembershipUser object returned by the membership provider does not implement the LastActivityDate and LastLoginDate properties, the code first checks the type of the user object returned from the membership provider before displaying the contents of those properties.

C#
VB
Copy 


<%@ Page Language="C#" %>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<script runat="server">

  protected void Page_Load(object sender, EventArgs e)
  {
    MembershipUser user =
        Membership.GetUser();

    userName.Text = user.UserName;
    emailAddress.Text = user.Email;

    if (user is ActiveDirectoryMembershipUser)
    {
      lastLoginDate.Text = "Not available";
      lastActivityDate.Text = "Not available";
    }
    else
    {
      lastLoginDate.Text = user.LastLoginDate.ToShortDateString();
      lastActivityDate.Text = user.LastActivityDate.ToShortDateString();
    }

    System.Security.Principal.SecurityIdentifier sidValue =
      (System.Security.Principal.SecurityIdentifier)user.ProviderUserKey;

    sid.Text = sidValue.ToString();
  }
</script>

<html xmlns="http://www.w3.org/1999/xhtml">
<head runat="server">
  <title>User information</title>
</head>
<body>
  <form id="form1" runat="server">
    <div>
      <table>
        <tr>
          <td>
            User name:</td>
          <td>
            <asp:Literal ID="userName" runat="server" /></td>
        </tr>
        <tr>
          <td>
            E-mail Address:</td>
          <td>
            <asp:Literal ID="emailAddress" runat="server" /></td>
        </tr>
        <tr>
          <td>
            Last Login Date:</td>
          <td>
            <asp:Literal ID="lastLoginDate" runat="server" /></td>
        </tr>
        <tr>
          <td>
            Last Activity Date:</td>
          <td>
            <asp:Literal ID="lastActivityDate" runat="server" /></td>
        </tr>
        <tr>
          <td>
            Security Identifier SID:</td>
          <td>
            <asp:Literal ID="sid" runat="server" /></td>
        </tr>
      </table>
    </div>
  </form>
</body>
</html>

.NET Framework

Supported in: 4, 3.5, 3.0, 2.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.
Did you find this helpful?
(1500 characters remaining)
Community Content Add
Annotations FAQ