SecurityPrincipal Class

Inheritance Hierarchy

SystemObject
  Galactic.ActiveDirectoryActiveDirectoryObject
    Galactic.ActiveDirectorySecurityPrincipal
      Galactic.ActiveDirectoryGroup
      Galactic.ActiveDirectoryUser

Namespace: Galactic.ActiveDirectory
Assembly: Galactic.ActiveDirectory (in Galactic.ActiveDirectory.dll) Version: 1.3.0.499 (1.3.0.499)

Syntax

C++

Copy

public class SecurityPrincipal : ActiveDirectoryObject, 
	IComparable<SecurityPrincipal>, IEqualityComparer<SecurityPrincipal>

Public Class SecurityPrincipal
	Inherits ActiveDirectoryObject
	Implements IComparable(Of SecurityPrincipal), IEqualityComparer(Of SecurityPrincipal)

public ref class SecurityPrincipal : public ActiveDirectoryObject, 
	IComparable<SecurityPrincipal^>, IEqualityComparer<SecurityPrincipal^>

type SecurityPrincipal =  
    class
        inherit ActiveDirectoryObject
        interface IComparable<SecurityPrincipal>
        interface IEqualityComparer<SecurityPrincipal>
    end

The SecurityPrincipal type exposes the following members.

Constructors

	Name	Description
	SecurityPrincipal(ActiveDirectory, SearchResultEntry)	Gets a security principal object from a supplied search result entry.
	SecurityPrincipal(ActiveDirectory, Guid)	Gets a security principal object from Active Directory with the supplied GUID.

Top

Properties

	Name	Description
	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.)
	Description	A description of the security principal.
	DistinguishedName	The Distinguished Name (DN) of the object in Active Directory. (Inherited from ActiveDirectoryObject.)
	EMailAddress	The principal's e-mail address.
	EmailAddresses	A list of the principal's e-mail addresses.
	ExchangeAlias	The principal's Microsoft Exchange Alias.
	Groups	The distinguished names of groups that this principal is a member of.
	GUID	The GUID of the object in Active Directory. (Inherited from ActiveDirectoryObject.)
	IsGroup	Indicates if this principal is a Group.
	IsUser	Indicates if this principal is a User.
	OrganizationalUnit	The distinguished name of the organizational unit or parent object containing the object. (Inherited from ActiveDirectoryObject.)
	PrimaryEmailAddress	The principal's primary e-mail address.
	SAMAccountName	The principal's SAM Account Name.
	SchemaClasses	The schema class types that identify the type of object this is in Active Directory. Examples: group, user, etc. (Inherited from ActiveDirectoryObject.)
	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.
	UserPrincipalName	The User Principal Name of the principal.

Top

Methods

	Name	Description
	AddProxyAddress	Adds a proxy e-mail address to the account's proxyAddresses field.
	AddToGroup	Adds this principal to the supplied group.
	CompareTo(ActiveDirectoryObject)	Compares this ActiveDirectoryObject to another ActiveDirectoryObject. (Inherited from ActiveDirectoryObject.)
	CompareTo(SecurityPrincipal)	Compares this SecurityPrincipal to another SecurityPrincipal.
	DeleteAttribute	Deletes values from an attribute. (Inherited from ActiveDirectoryObject.)
	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).
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	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.
	GetIntervalAttributeValue	Gets the UTC DateTime from a Interval attribute. (Inherited from ActiveDirectoryObject.)
	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.
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	MoveRename	Moves and / or renames this object. (Overrides ActiveDirectoryObjectMoveRename(NullableGuid, String).)
	Refresh	Refreshes the object to retrieve any changes made to attributes since creation. (Inherited from ActiveDirectoryObject.)
	RemoveFromGroup	Removes this principal from the supplied group.
	RemoveProxyAddress	Removes a proxy e-mail address from the account's proxyAddresses field.
	SetAttribute	Sets attribute of an object. If a null or empty values object is supplied no modifications will be made. (Inherited from ActiveDirectoryObject.)
	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.
	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.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

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

Top

Reference

Galactic.ActiveDirectory Namespace