This topic has not yet been rated - Rate this topic

AuthenticablePrincipal Class

.NET Framework 4

Encapsulates the account and contact data common to principals that can be authenticated.

System.Object
  System.DirectoryServices.AccountManagement.Principal
    System.DirectoryServices.AccountManagement.AuthenticablePrincipal
      System.DirectoryServices.AccountManagement.ComputerPrincipal
      System.DirectoryServices.AccountManagement.UserPrincipal

Namespace: System.DirectoryServices.AccountManagement
Assembly: System.DirectoryServices.AccountManagement (in System.DirectoryServices.AccountManagement.dll)

Syntax

C++

Copy

[DirectoryRdnPrefixAttribute("CN")]
[DirectoryServicesPermissionAttribute(SecurityAction.InheritanceDemand, Unrestricted = true)]
[DirectoryServicesPermissionAttribute(SecurityAction.LinkDemand, Unrestricted = true)]
public class AuthenticablePrincipal : Principal

The AuthenticablePrincipal type exposes the following members.

Constructors

	Name	Description
	AuthenticablePrincipal(PrincipalContext)	Initializes a new instance of the AuthenticablePrincipal class by using the specified context. This constructor is called by derived-class constructors to initialize the base class and is not intended for use directly from your code.
	AuthenticablePrincipal(PrincipalContext, String, String, Boolean)	Initializes a new instance of the AuthenticablePrincipal class by using the specified context, SAM account name, password, and enabled value. This constructor is called by derived-class constructors to initialize the base class and is not intended for use directly from your code.

Top

Properties

	Name	Description
	AccountExpirationDate	Gets or sets a Nullable DateTime that specifies the date and time that the account expires.
	AccountLockoutTime	Gets the Nullable DateTime that specifies the date and time that the account was locked out.
	AdvancedSearchFilter	Returns an AdvancedSearchFilter object, for use with Query By Example to set read-only properties before passing the object to the PrincipalSearcher.
	AllowReversiblePasswordEncryption	Gets or sets a Boolean value that specifies whether reversible password encryption is enabled for this account.
	BadLogonCount	Gets the number of logon attempts using incorrect credentials for this account.
	Certificates	Gets a X509Certificate2Collection that contains the X509 certificates for this account.
	Context	Gets a principal context that is associated with the principal. (Inherited from Principal.)
	ContextRaw	Gets a principal context that is associated with this principal. (Inherited from Principal.)
	ContextType	Gets the context type enumeraton value that specifies the type of principal context associated with this principal. (Inherited from Principal.)
	DelegationPermitted	Gets or sets a Nullable Boolean value that specifies whether the account may be delegated.
	Description	Gets or sets the description of the principal. (Inherited from Principal.)
	DisplayName	Gets or sets the display name for this principal. (Inherited from Principal.)
	DistinguishedName	Gets the distinguished name (DN) for this principal. (Inherited from Principal.)
	Enabled	Gets or sets a Nullable Boolean value that specifies whether this account is enabled for authentication.
	Guid	Gets the GUID associated with this principal. (Inherited from Principal.)
	HomeDirectory	Gets or sets the home directory for this account.
	HomeDrive	Gets or sets the home drive for this account.
	LastBadPasswordAttempt	Gets the Nullable DateTime that specifies the date and time of the last incorrect password attempt on this account.
	LastLogon	Gets the Nullable DateTime that specifies the date and time of the last logon for this account.
	LastPasswordSet	Gets the Nullable DateTime that specifies the last date and time that the password was set for this account.
	Name	Gets or sets the name of this principal. (Inherited from Principal.)
	PasswordNeverExpires	Gets or sets a Boolean value that specifies whether the password expires for this account.
	PasswordNotRequired	Gets or sets a Boolean value that specifies whether a password is required for this account.
	PermittedLogonTimes	Gets or sets the times when the principal can logon.
	PermittedWorkstations	Gets the list of workstations that this principal is permitted to log into.
	SamAccountName	Gets or sets the SAM account name for this principal. (Inherited from Principal.)
	ScriptPath	Gets or sets the script path for this account.
	Sid	Gets the Security ID (SID) of the principal. (Inherited from Principal.)
	SmartcardLogonRequired	Gets or sets a Boolean value that specifies whether a smartcard is required to log on to the account.
	StructuralObjectClass	Gets the structural object class directory attribute. (Inherited from Principal.)
	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.
	UserPrincipalName	Gets or sets the user principal name (UPN) associated with this principal. (Inherited from Principal.)

Top

Methods

	Name	Description
	ChangePassword	Changes the account password from the old password to the new password. Do not use this with a ComputerPrincipal.
	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.)
	Delete	Deletes the principal object from the store. (Inherited from Principal.)
	Dispose	Disposes the current instance of the Principal object. (Inherited from Principal.)
	Equals	Returns a Boolean value that specifies whether the supplied object is equal to the current object. (Inherited from Principal.)
	ExpirePasswordNow	Expires the password for this account. This will force the user to change his/her password at the next logon.
	ExtensionGet	Retrieves an attribute of an extended class object. (Inherited from Principal.)
	ExtensionSet	Sets the value of an attribute in an extended class. (Inherited from Principal.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	FindByBadPasswordAttempt(PrincipalContext, DateTime, MatchType)	Returns a collection of authentication principal objects that have an incorrect password try recorded in the specified date and time range.
	FindByBadPasswordAttempt<T>(PrincipalContext, DateTime, MatchType)	Returns a [T:System.DirectoryServices.AccountManagement.PrincipalSearchResult'1] collection of objects that have a bad password attempt within the specified date and time range. This is the template function for extended classes that wish to implement this functionality.
	FindByExpirationTime(PrincipalContext, DateTime, MatchType)	Returns a collection of authentication principal objects that have an account expiration time recorded in the specified date and time range.
	FindByExpirationTime<T>(PrincipalContext, DateTime, MatchType)	Returns a [T:System.DirectoryServices.AccountManagement.PrincipalSearchResult'1] collection of objects that have an expiration time within the specified date and time range. This is the template function for extended classes that wish to implement this functionality.
	FindByLockoutTime(PrincipalContext, DateTime, MatchType)	Returns a collection of authentication principal objects that have an account lockout time recorded in the specified date and time range.
	FindByLockoutTime<T>(PrincipalContext, DateTime, MatchType)	Returns a [T:System.DirectoryServices.AccountManagement.PrincipalSearchResult'1] collection of objects that have a lockout time within the specified date and time range. This is the template function for extended classes that wish to implement this functionality.
	FindByLogonTime(PrincipalContext, DateTime, MatchType)	Returns a collection of authentication principal objects that have an account logon recorded in the specified date and time range.
	FindByLogonTime<T>(PrincipalContext, DateTime, MatchType)	Returns a [T:System.DirectoryServices.AccountManagement.PrincipalSearchResult'1] collection of objects that have a logon time within the specified date and time range. This is the template function for extended classes that wish to implement this functionality.
	FindByPasswordSetTime(PrincipalContext, DateTime, MatchType)	Returns a collection of authentication principal objects that have an account password set recorded in the specified date and time range.
	FindByPasswordSetTime<T>(PrincipalContext, DateTime, MatchType)	Returns a [T:System.DirectoryServices.AccountManagement.PrincipalSearchResult'1] collection of objects that have a password set time within the specified date and time range. This is the template function for extended classes that wish to implement this functionality.
	GetGroups()	Returns a collection of group objects that specify the groups of which the current principal is a member. (Inherited from Principal.)
	GetGroups(PrincipalContext)	Returns a collection of group objects that the principal is a member of and that exist in the store provided by the specified context parameter. (Inherited from Principal.)
	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.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	GetUnderlyingObject	Returns the underlying DirectoryEntry object that provides the contact data for the principal object. (Inherited from Principal.)
	GetUnderlyingObjectType	Returns the underlying object type. (Inherited from Principal.)
	IsAccountLockedOut	Returns a Boolean value that specifies whether the account is currently locked out.
	IsMemberOf(GroupPrincipal)	Returns a Boolean value that specifies whether the principal is a member of the specified group. (Inherited from Principal.)
	IsMemberOf(PrincipalContext, IdentityType, String)	Returns a Boolean value that specifies whether the principal is a member of the group specified by identity type and value. (Inherited from Principal.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	RefreshExpiredPassword	Refreshes an expired password.
	Save()	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. (Inherited from Principal.)
	Save(PrincipalContext)	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 specified context. If the principal has already been persisted, it is moved from the original context to the specified context. (Inherited from Principal.)
	SetPassword	Sets the account password to the specified value.
	ToString	Returns a user friendly string representation of the current principal object. (Inherited from Principal.)
	UnlockAccount	Unlocks the account if it is currently locked out.

Top

Version Information

.NET Framework

Supported in: 4, 3.5

.NET Framework Client Profile

Supported in: 4

Platforms

Windows 7, Windows Vista SP1 or later, Windows XP SP3, 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.

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.

Reference

System.DirectoryServices.AccountManagement Namespace

System.DirectoryServices.AccountManagement

Other Resources

System.DirectoryServices.AccountManagement Namespace Overview

Did you find this helpful? Yes No

Not accurate

Not enough depth

Need more code examples

(1500 characters remaining)

Community Content Add

FAQ