Export (0) Print
Expand All

AuthenticablePrincipal Class

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

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

[<DirectoryRdnPrefixAttribute("CN")>]
[<DirectoryServicesPermissionAttribute(SecurityAction.InheritanceDemand, Unrestricted = true)>]
[<DirectoryServicesPermissionAttribute(SecurityAction.LinkDemand, Unrestricted = true)>]
type AuthenticablePrincipal =  
    class
        inherit Principal
    end

The AuthenticablePrincipal type exposes the following members.

  NameDescription
Protected methodAuthenticablePrincipal(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.
Protected methodAuthenticablePrincipal(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

  NameDescription
Public propertyAccountExpirationDateGets or sets a Nullable DateTime that specifies the date and time that the account expires.
Public propertyAccountLockoutTimeGets the Nullable DateTime that specifies the date and time that the account was locked out.
Public propertyAdvancedSearchFilterReturns an AdvancedSearchFilter object, for use with Query By Example to set read-only properties before passing the object to the PrincipalSearcher.
Public propertyAllowReversiblePasswordEncryptionGets or sets a Boolean value that specifies whether reversible password encryption is enabled for this account.
Public propertyBadLogonCountGets the number of logon attempts using incorrect credentials for this account.
Public propertyCertificatesGets a X509Certificate2Collection that contains the X509 certificates for this account.
Public propertyContextGets a principal context that is associated with the principal. (Inherited from Principal.)
Protected propertyContextRawGets a principal context that is associated with this principal. (Inherited from Principal.)
Public propertyContextTypeGets the context type enumeraton value that specifies the type of principal context associated with this principal. (Inherited from Principal.)
Public propertyDelegationPermittedGets or sets a Nullable Boolean value that specifies whether the account may be delegated.
Public propertyDescriptionGets or sets the description of the principal. (Inherited from Principal.)
Public propertyDisplayNameGets or sets the display name for this principal. (Inherited from Principal.)
Public propertyDistinguishedNameGets the distinguished name (DN) for this principal. (Inherited from Principal.)
Public propertyEnabledGets or sets a Nullable Boolean value that specifies whether this account is enabled for authentication.
Public propertyGuidGets the GUID associated with this principal. (Inherited from Principal.)
Public propertyHomeDirectoryGets or sets the home directory for this account.
Public propertyHomeDriveGets or sets the home drive for this account.
Public propertyLastBadPasswordAttemptGets the Nullable DateTime that specifies the date and time of the last incorrect password attempt on this account.
Public propertyLastLogonGets the Nullable DateTime that specifies the date and time of the last logon for this account.
Public propertyLastPasswordSetGets the Nullable DateTime that specifies the last date and time that the password was set for this account.
Public propertyNameGets or sets the name of this principal. (Inherited from Principal.)
Public propertyPasswordNeverExpiresGets or sets a Boolean value that specifies whether the password expires for this account.
Public propertyPasswordNotRequiredGets or sets a Boolean value that specifies whether a password is required for this account.
Public propertyPermittedLogonTimesGets or sets the times when the principal can logon.
Public propertyPermittedWorkstationsGets the list of workstations that this principal is permitted to log into.
Public propertySamAccountNameGets or sets the SAM account name for this principal. (Inherited from Principal.)
Public propertyScriptPathGets or sets the script path for this account.
Public propertySidGets the Security ID (SID) of the principal. (Inherited from Principal.)
Public propertySmartcardLogonRequiredGets or sets a Boolean value that specifies whether a smartcard is required to log on to the account.
Public propertyStructuralObjectClassGets the structural object class directory attribute. (Inherited from Principal.)
Public propertyUserCannotChangePasswordGets or sets a Boolean value that specifies whether the user can change the password for this account. Do not use this with a ComputerPrincipal.
Public propertyUserPrincipalNameGets or sets the user principal name (UPN) associated with this principal. (Inherited from Principal.)
Top

  NameDescription
Public methodChangePasswordChanges the account password from the old password to the new password. Do not use this with a ComputerPrincipal.
Protected methodCheckDisposedOrDeletedDetermines 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 methodDeleteDeletes the principal object from the store. (Inherited from Principal.)
Public methodDisposeDisposes the current instance of the Principal object. (Inherited from Principal.)
Public methodEqualsReturns a Boolean value that specifies whether the supplied object is equal to the current object. (Inherited from Principal.)
Public methodExpirePasswordNowExpires the password for this account. This will force the user to change his/her password at the next logon.
Protected methodExtensionGetRetrieves an attribute of an extended class object. (Inherited from Principal.)
Protected methodExtensionSetSets the value of an attribute in an extended class. (Inherited from Principal.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodStatic memberFindByBadPasswordAttempt(PrincipalContext, DateTime, MatchType)Returns a collection of authentication principal objects that have an incorrect password try recorded in the specified date and time range.
Protected methodStatic memberFindByBadPasswordAttempt(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.
Public methodStatic memberFindByExpirationTime(PrincipalContext, DateTime, MatchType)Returns a collection of authentication principal objects that have an account expiration time recorded in the specified date and time range.
Protected methodStatic memberFindByExpirationTime(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.
Public methodStatic memberFindByLockoutTime(PrincipalContext, DateTime, MatchType)Returns a collection of authentication principal objects that have an account lockout time recorded in the specified date and time range.
Protected methodStatic memberFindByLockoutTime(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.
Public methodStatic memberFindByLogonTime(PrincipalContext, DateTime, MatchType)Returns a collection of authentication principal objects that have an account logon recorded in the specified date and time range.
Protected methodStatic memberFindByLogonTime(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.
Public methodStatic memberFindByPasswordSetTime(PrincipalContext, DateTime, MatchType)Returns a collection of authentication principal objects that have an account password set recorded in the specified date and time range.
Protected methodStatic memberFindByPasswordSetTime(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.
Public methodGetGroups()Returns a collection of group objects that specify the groups of which the current principal is a member. (Inherited from Principal.)
Public methodGetGroups(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.)
Public methodGetHashCodeRetrieves 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 methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodGetUnderlyingObjectReturns the underlying DirectoryEntry object that provides the contact data for the principal object. (Inherited from Principal.)
Public methodGetUnderlyingObjectTypeReturns the underlying object type. (Inherited from Principal.)
Public methodIsAccountLockedOutReturns a Boolean value that specifies whether the account is currently locked out.
Public methodIsMemberOf(GroupPrincipal)Returns a Boolean value that specifies whether the principal is a member of the specified group. (Inherited from Principal.)
Public methodIsMemberOf(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.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodRefreshExpiredPasswordRefreshes an expired password.
Public methodSave()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.)
Public methodSave(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.)
Public methodSetPasswordSets the account password to the specified value.
Public methodToStringReturns a user friendly string representation of the current principal object. (Inherited from Principal.)
Public methodUnlockAccountUnlocks the account if it is currently locked out.
Top

.NET Framework

Supported in: 4, 3.5

.NET Framework Client Profile

Supported in: 4

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.

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

Community Additions

ADD
Show:
© 2014 Microsoft