 | User Class |
User is a class that allows for the query and manipulation of
Active Directory user objects.
Inheritance HierarchySystemObject
Galactic.ActiveDirectoryActiveDirectoryObject
Galactic.ActiveDirectorySecurityPrincipal
Galactic.ActiveDirectoryUser
Galactic.ActiveDirectoryActiveDirectoryObject
Galactic.ActiveDirectorySecurityPrincipal
Galactic.ActiveDirectoryUser
Namespace: Galactic.ActiveDirectory
Assembly: Galactic.ActiveDirectory (in Galactic.ActiveDirectory.dll) Version: 1.3.0.499 (1.3.0.499)
SyntaxThe User type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | User(ActiveDirectory, SearchResultEntry) |
Gets a user object from a supplied search result entry.
|
| User(ActiveDirectory, Guid) |
Gets a user object from Active Directory with the supplied GUID.
|
Properties| Name | Description | |
|---|---|---|
 | BadPasswordCount |
The number of times the user has entered a bad password.
Returns a negative number is there is an error retrieving the value.
|
| BadPasswordTime |
The last time that the user entered a bad password when authenticating to AD.
|
| CommonName |
The Common Name (CN) of the object in Active Directory.
(Inherited from ActiveDirectoryObject.) |
| CreateTimeStamp |
The time the object was created in UTC.
(Inherited from ActiveDirectoryObject.) |
| Department |
The Department the user belongs to.
|
| Description |
A description of the security principal.
(Inherited from SecurityPrincipal.) |
| DisplayName |
The user's display name.
|
| DistinguishedName |
The Distinguished Name (DN) of the object in Active Directory.
(Inherited from ActiveDirectoryObject.) |
| Division |
The user's division in the organization.
|
| EMailAddress |
The principal's e-mail address.
(Inherited from SecurityPrincipal.) |
| EmailAddresses |
A list of the principal's e-mail addresses.
(Inherited from SecurityPrincipal.) |
| EmployeeId |
The Employee Id of the user.
|
| EmployeeNumber |
The employee number of the user.
|
| ExchangeAlias |
The principal's Microsoft Exchange Alias.
(Inherited from SecurityPrincipal.) |
| FirstName |
The user's first name.
|
| FTPDirectory |
The FTP Directory for the user off the FTP root.
|
| FTPRoot |
The root directory for FTP access by the user.
|
| Groups |
The distinguished names of groups that this principal is a member of.
(Inherited from SecurityPrincipal.) |
| GUID |
The GUID of the object in Active Directory.
(Inherited from ActiveDirectoryObject.) |
| HomeDirectory |
The path to the user's home directory.
|
| HomeDrive |
The user's home drive letter.
|
| HomePage |
The user's home page URL.
|
| IsDisabled |
Whether the user's account is disabled in Active Directory.
|
| IsGroup |
Indicates if this principal is a Group.
(Inherited from SecurityPrincipal.) |
| IsUser |
Indicates if this principal is a User.
(Inherited from SecurityPrincipal.) |
| LastName |
The user's last name.
|
| LogonScript |
The path to the user's logon script.
|
| Manager |
The distinguished name of the user's Manager.
|
| MustChangePasswordAtNextLogon |
Whether the user has to change their password at their next logon.
|
| OrganizationalUnit |
The distinguished name of the organizational unit or parent object containing the object.
(Inherited from ActiveDirectoryObject.) |
| PasswordExpired |
Whether the user's password has expired.
|
| PasswordLastSet |
The date and time that the user's password was last site.
|
| PhoneNumber |
The user's telephone number.
|
| PrimaryEmailAddress |
The principal's primary e-mail address.
(Inherited from SecurityPrincipal.) |
| SAMAccountName |
The principal's SAM Account Name.
(Inherited from SecurityPrincipal.) |
| SchemaClasses |
The schema class types that identify the type of object this is in Active Directory.
Examples: group, user, etc.
(Inherited from ActiveDirectoryObject.) |
| SecurityIdentifier |
The user's security identifier (SID).
|
| StreetAddress |
The user's street address.
|
| TargetAddress |
The principal's target e-mail address. Used by Exchange for routing e-mail to its
final destination which may lie outside of the organization. Allows for an object
to appear in the GAL even though its e-mail address may be outside of Exchange.
Also used when routing e-mail to the Microsoft Office365 cloud from an on-premises
Exchange server.
(Inherited from SecurityPrincipal.) |
| Title |
The user's title.
|
| UserAccountControl |
Gets the user's UserAccountControl property.
A return of 0 means there was an error retrieving the property.
|
| UserAccountControlComputed |
Gets the user's computed UserAccountControl property.
A return value of 0 means it wasn't computed.
|
| UserPrincipalName |
The User Principal Name of the principal.
(Inherited from SecurityPrincipal.) |
Methods| Name | Description | |
|---|---|---|
| AddProxyAddress |
Adds a proxy e-mail address to the account's proxyAddresses field.
(Inherited from SecurityPrincipal.) |
| AddToGroup |
Adds this principal to the supplied group.
(Inherited from SecurityPrincipal.) |
| CompareTo(ActiveDirectoryObject) |
Compares this ActiveDirectoryObject to another ActiveDirectoryObject.
(Inherited from ActiveDirectoryObject.) |
| CompareTo(SecurityPrincipal) |
Compares this SecurityPrincipal to another SecurityPrincipal.
(Inherited from SecurityPrincipal.) |
| CompareTo(User) |
Compares this User to another User.
|
 | Create |
Creates a new user within Active Directory given it's proposed name, the distinguished name of the OU to place it in, and other optional attributes.
|
| DeleteAttribute |
Deletes values from an attribute.
(Inherited from ActiveDirectoryObject.) |
| Disable |
Disables the user's account for authentication if it is enabled.
|
| Enable |
Enables the user's account for authentication if it is disabled.
|
| Equals(Object) | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| Equals(ActiveDirectoryObject, ActiveDirectoryObject) |
Checks whether x and y are equal (using GUIDs).
(Inherited from ActiveDirectoryObject.) |
| Equals(SecurityPrincipal, SecurityPrincipal) |
Checks whether x and y are equal (using GUIDs).
(Inherited from SecurityPrincipal.) |
| Equals(User, User) |
Checks whether x and y are equal (using GUIDs).
|
 | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetAllUsers |
Gets all users in the Active Directory.
|
| GetByteAttributeValue |
Gets the first byte array value from the supplied attribute of the object.
(Inherited from ActiveDirectoryObject.) |
| GetByteAttributeValues |
Gets all byte array values from the supplied attribute of the object.
(Inherited from ActiveDirectoryObject.) |
| GetEntryFromAD(Guid) |
Gets new data for the object from AD and places the values in the entry variable within the object.
(Inherited from ActiveDirectoryObject.) |
| GetEntryFromAD(Guid, ListString) |
Gets new data for the object from AD and places the values in the entry variable within the object.
(Inherited from ActiveDirectoryObject.) |
| GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
| GetHashCode(ActiveDirectoryObject) |
Generates a hash code for the ActiveDirectoryObject supplied.
(Inherited from ActiveDirectoryObject.) |
| GetHashCode(SecurityPrincipal) |
Generates a hash code for the SecurityPrincipal supplied.
(Inherited from SecurityPrincipal.) |
| GetHashCode(User) |
Generates a hash code for the User supplied.
|
| GetIntervalAttributeValue |
Gets the UTC DateTime from a Interval attribute.
(Inherited from ActiveDirectoryObject.) |
| GetModifiedUsers |
Gets of all user accounts that were modified within the specified time frame.
|
| GetStringAttributeValue |
Gets the first string value from the supplied attribute of the object.
(Inherited from ActiveDirectoryObject.) |
| GetStringAttributeValues |
Gets all string values from the supplied attribute of the object.
(Inherited from ActiveDirectoryObject.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| MemberOfGroup |
Checks if this principal is a member of the supplied group.
(Inherited from SecurityPrincipal.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| MoveRename |
Moves and / or renames this object.
(Inherited from SecurityPrincipal.) |
| Refresh |
Refreshes the object to retrieve any changes made to attributes since creation.
(Inherited from ActiveDirectoryObject.) |
| RemoveFromGroup |
Removes this principal from the supplied group.
(Inherited from SecurityPrincipal.) |
| RemoveProxyAddress |
Removes a proxy e-mail address from the account's proxyAddresses field.
(Inherited from SecurityPrincipal.) |
| RemoveUserAccountControlFlag |
Removes a flag from the user's User Account Control attribute.
|
| SetAttribute |
Sets attribute of an object. If a null or empty values object is supplied no modifications will be made.
(Inherited from ActiveDirectoryObject.) |
| SetPassword |
Sets the password of the user.
|
| SetPrimaryProxyAddress |
Sets the supplied e-mail address to be the primary e-mail address for receiving mail.
Note: This e-mail address must already be associated with the account.
If there is account currently has a primary e-mail address, it will be set as a secondary.
(Inherited from SecurityPrincipal.) |
| SetStringAttribute |
Sets a single value string attribute of an object. If a null or empty value is supplied,
the attribute will be cleared / deleted.
(Inherited from ActiveDirectoryObject.) |
| SetUserAccountControlFlag |
Sets a flag in the user's User Account Control attribute.
|
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
| Unlock |
Unlocks the user's account if it is locked.
|
Fields| Name | Description | |
|---|---|---|
 | AD | (Inherited from ActiveDirectoryObject.) |
| AdditionalAttributes | (Inherited from ActiveDirectoryObject.) |
| AttributeNames |
The list of specific attributes that should be retrieved when searching for the entry in AD. The attributes of parent objects should be included as well.
|
| Attributes | (Inherited from ActiveDirectoryObject.) |
| Entry | (Inherited from ActiveDirectoryObject.) |
| JAN_01_1601 | (Inherited from ActiveDirectoryObject.) |
See Also