This documentation is archived and is not being maintained.

UserPrincipal Members

Visual Studio 2008

Encapsulates principals that are user accounts.

The UserPrincipal type exposes the following members.

  NameDescription
Public method UserPrincipal Overloaded. Initializes a new instance of the UserPrincipal class.
Top

  NameDescription
Public method ChangePassword Changes the account password from the old password to the new password. Do not use this with a ComputerPrincipal. (Inherited from AuthenticablePrincipal.)
Protected method CheckDisposedOrDeleted Determines whether the Dispose or Delete methods have been called on this class. This method is called by classes that derive from this principal class. (Inherited from Principal.)
Public method Delete Deletes the principal object from the store. (Inherited from Principal.)
Public method Dispose Disposes the current instance of the Principal object. (Inherited from Principal.)
Public method Equals Returns a Boolean value that specifies whether the supplied object is equal to the current object. (Inherited from Principal.)
Public method ExpirePasswordNow Expires the password for this account. This will force the user to change his/her password at the next logon. (Inherited from AuthenticablePrincipal.)
Protected method ExtensionGet Retrieves an attribute of an extended class object. (Inherited from Principal.)
Protected method ExtensionSet Sets the value of an attribute in an extended class. (Inherited from Principal.)
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 Static member FindByBadPasswordAttempt Returns a collection of [T:System.DirectoryServices.AccountManagement.PrincipleSearchResult'1] objects for users that have an incorrect password attempt recorded in the specified date and time range.
Public method Static member FindByExpirationTime Returns a collection of [T:System.DirectoryServices.AccountManagement.PrincipleSearchResult'1] objects for users that have an account expiration time in the specified date and time range.
Public method Static member FindByIdentity Overloaded. Returns a user principal object that matches the specified identity value.
Public method Static member FindByLockoutTime Returns a collection of [T:System.DirectoryServices.AccountManagement.PrincipleSearchResult'1] objects for users that have an account lockout time in the specified date and time range.
Public method Static member FindByLogonTime Returns a collection of [T:System.DirectoryServices.AccountManagement.PrincipleSearchResult'1] objects for users that have account logon recorded in the specified date and time range.
Public method Static member FindByPasswordSetTime Returns a collection of [T:System.DirectoryServices.AccountManagement.PrincipleSearchResult'1] objects for users that have set their password within the specified date and time range.
Public method GetAuthorizationGroups Returns a collection of principal objects that contains all the authorization groups of which this user is a member. This function only returns groups that are security groups; distribution groups are not returned.
Public method GetGroups Overloaded. Returns a collection of group objects that specify the groups of which the current principal is a member.
Public method GetHashCode Retrieves the hash created from the contents of the principal object, suited for use in hashing algorithms and data structures like a hash table. (Inherited from Principal.)
Public method GetType Gets the type of the current instance. (Inherited from Object.)
Public method GetUnderlyingObject Returns the underlying DirectoryEntry object that provides the contact data for the principal object. (Inherited from Principal.)
Public method GetUnderlyingObjectType Returns the underlying object type. (Inherited from Principal.)
Public method IsAccountLockedOut Returns a Boolean value that specifies whether the account is currently locked out. (Inherited from AuthenticablePrincipal.)
Public method IsMemberOf Overloaded. Returns a Boolean value that specifies whether the group is a member of the specified group.
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method RefreshExpiredPassword Refreshes an expired password. (Inherited from AuthenticablePrincipal.)
Public method Save Overloaded. Saves the changes that were made on the principal object to the store. If this is a new principal object, this method inserts it into the store.
Public method SetPassword Sets the account password to the specified value. (Inherited from AuthenticablePrincipal.)
Public method ToString Returns a user friendly string representation of the current principal object. (Inherited from Principal.)
Public method UnlockAccount Unlocks the account if it is currently locked out. (Inherited from AuthenticablePrincipal.)
Top

  NameDescription
Public property AccountExpirationDate Gets or sets a Nullable DateTime that specifies the date and time that the account expires. (Inherited from AuthenticablePrincipal.)
Public property AccountLockoutTime Gets the Nullable DateTime that specifies the date and time that the account was locked out. (Inherited from AuthenticablePrincipal.)
Public property AdvancedSearchFilter Returns an AdvancedSearchFilter object, for use with Query By Example to set read-only properties before passing the object to the PrincipalSearcher. (Overrides AuthenticablePrincipal.AdvancedSearchFilter.)
Public property AllowReversiblePasswordEncryption Gets or sets a Boolean value that specifies whether reversible password encryption is enabled for this account. (Inherited from AuthenticablePrincipal.)
Public property BadLogonCount Gets the number of logon attempts using incorrect credentials for this account. (Inherited from AuthenticablePrincipal.)
Public property Certificates Gets a X509Certificate2Collection that contains the X509 certificates for this account. (Inherited from AuthenticablePrincipal.)
Public property Context Gets a principal context that is associated with the principal. (Inherited from Principal.)
Protected property ContextRaw Gets a principal context that is associated with this principal. (Inherited from Principal.)
Public property ContextType Gets the context type enumeraton value that specifies the type of principal context associated with this principal. (Inherited from Principal.)
Public property Static member Current Gets a user principal object that represents the current user under which the thread is running.
Public property DelegationPermitted Gets or sets a Nullable Boolean value that specifies whether the account may be delegated. (Inherited from AuthenticablePrincipal.)
Public property Description Gets or sets the description of the principal. (Inherited from Principal.)
Public property DisplayName Gets or sets the display name for this principal. (Inherited from Principal.)
Public property DistinguishedName Gets the distinguished name (DN) for this principal. (Inherited from Principal.)
Public property EmailAddress Gets or sets the e-mail address for this account.
Public property EmployeeId Gets or sets the employee ID for this user principal.
Public property Enabled Gets or sets a Nullable Boolean value that specifies whether this account is enabled for authentication. (Inherited from AuthenticablePrincipal.)
Public property GivenName Gets or sets the given name for the user principal.
Public property Guid Gets the GUID associated with this principal. (Inherited from Principal.)
Public property HomeDirectory Gets or sets the home directory for this account. (Inherited from AuthenticablePrincipal.)
Public property HomeDrive Gets or sets the home drive for this account. (Inherited from AuthenticablePrincipal.)
Public property LastBadPasswordAttempt Gets the Nullable DateTime that specifies the date and time of the last incorrect password attempt on this account. (Inherited from AuthenticablePrincipal.)
Public property LastLogon Gets the Nullable DateTime that specifies the date and time of the last logon for this account. (Inherited from AuthenticablePrincipal.)
Public property LastPasswordSet Gets the Nullable DateTime that specifies the last date and time that the password was set for this account. (Inherited from AuthenticablePrincipal.)
Public property MiddleName Gets or sets the middle name for the user principal.
Public property Name Gets or sets the name of this principal. (Inherited from Principal.)
Public property PasswordNeverExpires Gets or sets a Boolean value that specifies whether the password expires for this account. (Inherited from AuthenticablePrincipal.)
Public property PasswordNotRequired Gets or sets a Boolean value that specifies whether a password is required for this account. (Inherited from AuthenticablePrincipal.)
Public property PermittedLogonTimes Gets or sets the times when the principal can logon. (Inherited from AuthenticablePrincipal.)
Public property PermittedWorkstations Gets the list of workstations that this principal is permitted to log into. (Inherited from AuthenticablePrincipal.)
Public property SamAccountName Gets or sets the SAM account name for this principal. (Inherited from Principal.)
Public property ScriptPath Gets or sets the script path for this account. (Inherited from AuthenticablePrincipal.)
Public property Sid Gets the Security ID (SID) of the principal. (Inherited from Principal.)
Public property SmartcardLogonRequired Gets or sets a Boolean value that specifies whether a smartcard is required to log on to the account. (Inherited from AuthenticablePrincipal.)
Public property StructuralObjectClass Gets the structural object class directory attribute. (Inherited from Principal.)
Public property Surname Gets or sets the surname for the user principal.
Public property UserCannotChangePassword Gets or sets a Boolean value that specifies whether the user can change the password for this account. Do not use this with a ComputerPrincipal. (Inherited from AuthenticablePrincipal.)
Public property UserPrincipalName Gets or sets the user principal name (UPN) associated with this principal. (Inherited from Principal.)
Public property VoiceTelephoneNumber Gets or sets the voice telephone number for the user principal.
Top
Show: