UserPrincipal Class

UserPrincipal Class

.NET Framework (current version)
 

Encapsulates principals that are user accounts.

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


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

NameDescription
System_CAPS_pubmethodUserPrincipal(PrincipalContext)

Initializes a new instance of the UserPrincipal class by using the specified context.

System_CAPS_pubmethodUserPrincipal(PrincipalContext, String, String, Boolean)

Initializes a new instance of the UserPrincipal class by using the specified context, SAM account name, password, and enabled value.

NameDescription
System_CAPS_pubpropertyAccountExpirationDate

Gets or sets a Nullable DateTime that specifies the date and time that the account expires. (Inherited from AuthenticablePrincipal.)

System_CAPS_pubpropertyAccountLockoutTime

Gets the Nullable DateTime that specifies the date and time that the account was locked out. (Inherited from AuthenticablePrincipal.)

System_CAPS_pubpropertyAdvancedSearchFilter

Returns an T:System.DirectoryServices.AccountManagement.AdvancedSearchFilter object, for use with 84ac40bb-04c4-4d0b-adaf-0ddb9253599e to set read-only properties before passing the object to the PrincipalSearcher.(Overrides AuthenticablePrincipal.AdvancedSearchFilter.)

System_CAPS_pubpropertyAllowReversiblePasswordEncryption

Gets or sets a Boolean value that specifies whether reversible password encryption is enabled for this account. (Inherited from AuthenticablePrincipal.)

System_CAPS_pubpropertyBadLogonCount

Gets the number of logon attempts using incorrect credentials for this account. (Inherited from AuthenticablePrincipal.)

System_CAPS_pubpropertyCertificates

Gets a T:System.X509Certificate2Collection that contains the X509 certificates for this account. (Inherited from AuthenticablePrincipal.)

System_CAPS_pubpropertyContext

Gets a principal context that is associated with the principal. (Inherited from Principal.)

System_CAPS_protpropertyContextRaw

Gets a principal context that is associated with this principal. (Inherited from Principal.)

System_CAPS_pubpropertyContextType

Gets the context type enumeraton value that specifies the type of principal context associated with this principal. (Inherited from Principal.)

System_CAPS_pubpropertySystem_CAPS_staticCurrent

Gets a user principal object that represents the current user under which the thread is running.

System_CAPS_pubpropertyDelegationPermitted

Gets or sets a Nullable Boolean value that specifies whether the account may be delegated. (Inherited from AuthenticablePrincipal.)

System_CAPS_pubpropertyDescription

Gets or sets the description of the principal. (Inherited from Principal.)

System_CAPS_pubpropertyDisplayName

Gets or sets the display name for this principal.(Inherited from Principal.)

System_CAPS_pubpropertyDistinguishedName

Gets the distinguished name (DN) for this principal.(Inherited from Principal.)

System_CAPS_pubpropertyEmailAddress

Gets or sets the e-mail address for this account.

System_CAPS_pubpropertyEmployeeId

Gets or sets the employee ID for this user principal.

System_CAPS_pubpropertyEnabled

Gets or sets a Nullable Boolean value that specifies whether this account is enabled for authentication. (Inherited from AuthenticablePrincipal.)

System_CAPS_pubpropertyGivenName

Gets or sets the given name for the user principal.

System_CAPS_pubpropertyGuid

Gets the GUID associated with this principal. (Inherited from Principal.)

System_CAPS_pubpropertyHomeDirectory

Gets or sets the home directory for this account. (Inherited from AuthenticablePrincipal.)

System_CAPS_pubpropertyHomeDrive

Gets or sets the home drive for this account. (Inherited from AuthenticablePrincipal.)

System_CAPS_pubpropertyLastBadPasswordAttempt

Gets the Nullable DateTime that specifies the date and time of the last incorrect password attempt on this account. (Inherited from AuthenticablePrincipal.)

System_CAPS_pubpropertyLastLogon

Gets the Nullable DateTime that specifies the date and time of the last logon for this account. (Inherited from AuthenticablePrincipal.)

System_CAPS_pubpropertyLastPasswordSet

Gets the Nullable DateTime that specifies the last date and time that the password was set for this account. (Inherited from AuthenticablePrincipal.)

System_CAPS_pubpropertyMiddleName

Gets or sets the middle name for the user principal.

System_CAPS_pubpropertyName

Gets or sets the name of this principal. (Inherited from Principal.)

System_CAPS_pubpropertyPasswordNeverExpires

Gets or sets a Boolean value that specifies whether the password expires for this account. (Inherited from AuthenticablePrincipal.)

System_CAPS_pubpropertyPasswordNotRequired

Gets or sets a Boolean value that specifies whether a password is required for this account. (Inherited from AuthenticablePrincipal.)

System_CAPS_pubpropertyPermittedLogonTimes

Gets or sets the times when the principal can logon. (Inherited from AuthenticablePrincipal.)

System_CAPS_pubpropertyPermittedWorkstations

Gets the list of workstations that this principal is permitted to log into. (Inherited from AuthenticablePrincipal.)

System_CAPS_pubpropertySamAccountName

Gets or sets the SAM account name for this principal. (Inherited from Principal.)

System_CAPS_pubpropertyScriptPath

Gets or sets the script path for this account. (Inherited from AuthenticablePrincipal.)

System_CAPS_pubpropertySid

Gets the Security ID (SID) of the principal. (Inherited from Principal.)

System_CAPS_pubpropertySmartcardLogonRequired

Gets or sets a Boolean value that specifies whether a smartcard is required to log on to the account. (Inherited from AuthenticablePrincipal.)

System_CAPS_pubpropertyStructuralObjectClass

Gets the structural object class directory attribute.(Inherited from Principal.)

System_CAPS_pubpropertySurname

Gets or sets the surname for the user principal.

System_CAPS_pubpropertyUserCannotChangePassword

Gets or sets a Boolean value that specifies whether the user can change the password for this account. Do not use this with a T:System.DirecoryServices.AccountManagement.ComputerPrincipal.(Inherited from AuthenticablePrincipal.)

System_CAPS_pubpropertyUserPrincipalName

Gets or sets the user principal name (UPN) associated with this principal. (Inherited from Principal.)

System_CAPS_pubpropertyVoiceTelephoneNumber

Gets or sets the voice telephone number for the user principal.

NameDescription
System_CAPS_pubmethodChangePassword(String, String)

Changes the account password from the old password to the new password. Do not use this with a T:System.DirecoryServices.AccountManagement.ComputerPrincipal.(Inherited from AuthenticablePrincipal.)

System_CAPS_protmethodCheckDisposedOrDeleted()

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.)

System_CAPS_pubmethodDelete()

Deletes the principal object from the store. (Inherited from Principal.)

System_CAPS_pubmethodDispose()

Disposes the current instance of the Principal object.(Inherited from Principal.)

System_CAPS_pubmethodEquals(Object)

Returns a Boolean value that specifies whether the supplied object is equal to the current object. (Inherited from Principal.)

System_CAPS_pubmethodExpirePasswordNow()

Expires the password for this account. This will force the user to change his/her password at the next logon.(Inherited from AuthenticablePrincipal.)

System_CAPS_protmethodExtensionGet(String)

Retrieves an attribute of an extended class object.(Inherited from Principal.)

System_CAPS_protmethodExtensionSet(String, Object)

Sets the value of an attribute in an extended class.(Inherited from Principal.)

System_CAPS_protmethodFinalize()

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)

System_CAPS_pubmethodSystem_CAPS_staticFindByBadPasswordAttempt(PrincipalContext, DateTime, MatchType)

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.

System_CAPS_pubmethodSystem_CAPS_staticFindByExpirationTime(PrincipalContext, DateTime, MatchType)

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.

System_CAPS_pubmethodSystem_CAPS_staticFindByIdentity(PrincipalContext, IdentityType, String)

Returns a user principal object that matches the specified identity type, and value. This version of the FindByIdentity method determines the format of the identity value.

System_CAPS_pubmethodSystem_CAPS_staticFindByIdentity(PrincipalContext, String)

Returns a user principal object that matches the specified identity value.

System_CAPS_pubmethodSystem_CAPS_staticFindByLockoutTime(PrincipalContext, DateTime, MatchType)

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.

System_CAPS_pubmethodSystem_CAPS_staticFindByLogonTime(PrincipalContext, DateTime, MatchType)

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.

System_CAPS_pubmethodSystem_CAPS_staticFindByPasswordSetTime(PrincipalContext, DateTime, MatchType)

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.

System_CAPS_pubmethodGetAuthorizationGroups()

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.

System_CAPS_pubmethodGetGroups()

Returns a collection of group objects that specify the groups of which the current principal is a member. (Inherited from Principal.)

System_CAPS_pubmethodGetGroups(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.)

System_CAPS_pubmethodGetHashCode()

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.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_pubmethodGetUnderlyingObject()

Returns the underlying DirectoryEntry object that provides the contact data for the principal object. (Inherited from Principal.)

System_CAPS_pubmethodGetUnderlyingObjectType()

Returns the underlying object type. (Inherited from Principal.)

System_CAPS_pubmethodIsAccountLockedOut()

Returns a Boolean value that specifies whether the account is currently locked out. (Inherited from AuthenticablePrincipal.)

System_CAPS_pubmethodIsMemberOf(GroupPrincipal)

Returns a Boolean value that specifies whether the principal is a member of the specified group. (Inherited from Principal.)

System_CAPS_pubmethodIsMemberOf(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.)

System_CAPS_protmethodMemberwiseClone()

Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_pubmethodRefreshExpiredPassword()

Refreshes an expired password. (Inherited from AuthenticablePrincipal.)

System_CAPS_pubmethodSave()

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.)

System_CAPS_pubmethodSave(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.)

System_CAPS_pubmethodSetPassword(String)

Sets the account password to the specified value. (Inherited from AuthenticablePrincipal.)

System_CAPS_pubmethodToString()

Returns a user friendly string representation of the current principal object.(Inherited from Principal.)

System_CAPS_pubmethodUnlockAccount()

Unlocks the account if it is currently locked out. (Inherited from AuthenticablePrincipal.)

.NET Framework
Available since 3.5

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

Return to top
Show:
© 2016 Microsoft