User Class

User logins. Entity: Sec_Users

Inheritance Hierarchy

SystemObject
  Aloe.SystemFrameworks.DomainDomainObject
    Aloe.SystemFrameworks.DomainEditableDomainObject
      Aloe.SystemFrameworks.DomainEntityObject
        Aloe.EnterpriseOne.Model.CoreEnterpriseOneEntityObject
          Aloe.EnterpriseOne.Model.Systems.SecurityUser

Namespace: Aloe.EnterpriseOne.Model.Systems.Security
Assembly: Aloe.EnterpriseOne.Model (in Aloe.EnterpriseOne.Model.dll) Version: 20.1.3.5

Syntax

C++

Copy

public class User : EnterpriseOneEntityObject

Public Class User
	Inherits EnterpriseOneEntityObject

public ref class User : public EnterpriseOneEntityObject

type User =  
    class
        inherit EnterpriseOneEntityObject
    end

The User type exposes the following members.

Constructors

	Name	Description
	User	Initializes a new instance of the User class with specific ObjectTransaction

Top

Properties

	Name	Description
	AccessFailedCount	Indicates how many times the user has failed to login. May be used for locking out the user. [Required] [Default(0)] [Filter(eq;ge;le)]
	AccessKeys	List of UserAccessKey child objects, based on the Systems.Security.UserAccessKey.User back reference
	Active	True when the login is currently active and the user can log in. [Required] [Default(true)] [Filter(eq)]
	ChangingAttributes	Gets the attributes that are currently changing. Can be used in attribute change event handler to prevent stack overflow. (Inherited from EditableDomainObject.)
	CreationTimeUtc	The date and time (in UTC), when the user was created. [Required] [Default(Now)] [ReadOnly]
	CustomProperties	Gets the custom properties of the object. (Inherited from EnterpriseOneEntityObject.)
	DefaultCulture	The preferred default culture of the user for UI, notifications, etc. null means "en-US".
	Domain	The domain, to which the user belongs. [Filter(multi eq)]
	Email	Unique email of the user. Can be null because there may be login providers that don't use emails. [Filter(multi eq;like)] [ORD]
	EmailConfirmed	Indicates whether the email address for the specified user has been verified. [Required] [Default(false)] [Filter(eq)]
	ExtendedProperties	Extended properties contain temporary (not persisted) values in the object instance. (Inherited from EntityObject.)
	Groups	List of UserGroup child objects, based on the Systems.Security.UserGroup.User back reference
	Id	The unique Id of the entity object (Inherited from EntityObject.)
	IsAdmin	True if the user is administrator, otherwise false. [Required] [Default(false)] [Filter(eq)]
	IsGhost	Returns true when the object is a ghost object (Inherited from EntityObject.)
	IsLoaded	Gets a value indicating whether the associated data for this domain object is loaded. (Overrides EntityObjectIsLoaded.)
	ItemString	Gets or sets the value of a data attribute (Inherited from DomainObject.)
	ItemIDataAttribute	Gets or sets the value of a data attribute (Inherited from DomainObject.)
	LockoutEndUtc	Contains the date and time (in UTC) until the user is locked. null when the user is not locked. [Filter(eq;ge;le;like)]
	Login	The login name of the user, which is usually the email. [Required] [Filter(multi eq;like)] [ORD]
	Name	The full name of the user. [Required] [Filter(like)]
	NoEvents	Turns on "No events" mode and returns a class, that will turn it off when Disposed. See remarks for more info. (Inherited from DomainObject.)
	Notes	Notes for this User.
	ObjectState	Gets the state of the domain object. (Overrides EditableDomainObjectObjectState.)
	Password	The password hash of the user, stored in the format, specified in Password Format.
	PasswordFormat	The format of the Password. MD5=MD5 format; AN3 = ASP.NET Core Identity v3. [Required] [Default("MD5")] [Filter(eq)]
	Person	The person from within the system, which is authenticated with this login. null means that this user is not associated with a person record in the database. [Filter(multi eq)]
	PhoneNumber	Used only for two-factor authentication. null when phone-based two-factor is not used. [Filter(eq;like)]
	PhoneNumberConfirmed	Indicates whether the Phone Number has been verified. [Required] [Default(false)] [Filter(eq)]
	ProviderLogins	List of UserProviderLogin child objects, based on the Systems.Security.UserProviderLogin.User back reference
	ProviderTokens	List of UserProviderToken child objects, based on the Systems.Security.UserProviderToken.User back reference
	Repository	Provides access to UsersRepository repository methods
	Transaction	The EnterpriseOne transaction to which this object is attached. (Inherited from EnterpriseOneEntityObject.)
	TwoFactorEnabled	Indicates whether two-factor authentication has been enabled. [Required] [Default(false)] [Filter(eq)]
	UserType	Specifies the user type. INT=Internal; EXT=External (community); VIR=Virtual (No login); SYS=System; APP=Application. [Required] [Default("INT")] [Filter(multi eq)]
	VoiceExtensionNumbers	Comma separated list of internal extension numbers of the voice telephones of the user. Used for VOIP integration.
	WindowsUserName	The Windows (Active Directory) user, to which this login is bound. The user will be allowed to login only when the client machine is logged in Active Directory with the specified user.

Top

Methods

	Name	Description
	CheckPassword	Checks the User's password
	Delete	Deletes the domain object. (Overrides EntityObjectDelete.)
	DuplicateObject	Creates a copy of the object. (Inherited from EntityObject.)
	Equals(Object)	Determines whether the specified Object, is equal to this instance. (Inherited from EntityObject.)
	Equals(EntityObject)	Indicates whether the current object is equal to another object of the same type. (Inherited from EntityObject.)
	ExecuteBusinessRules	Executes all business rules for the object for the specified BusinessEvent. The validation fails are saved in the event. (Inherited from EditableDomainObject.)
	GetAggregateParent	Gets the aggregate parent of this entity object. If this is the aggregate root the return value is null. (Inherited from EntityObject.)
	GetAggregateRoot	Gets the aggregate root entity object. If the entity does not have aggregate parent reference aggregate root is this entity object. (Inherited from EntityObject.)
	GetGroupAccessKeys	Gets the group access key.
	GetHashCode	Returns a hash code for this instance. (Inherited from EntityObject.)
	GetRelatedObjectsForValidation	Gets the related objects which would need validation upon validation of this object. (Inherited from EntityObject.)
	HasAccess	Determines whether the specified access key has access.
	HasPermission	Determines whether the user has the specified permission for the given access key.
	IssueWarning(String)	Issues a warning with the specified message. (Inherited from EditableDomainObject.)
	IssueWarning(ExpressionFuncString, Object)	Issues a warning with the specified message. The message can contain standard string placeholders. (Inherited from EditableDomainObject.)
	MatchesFilter(DataAccessFilter)	Returns true if this entity object matches the specified filter. (Inherited from EnterpriseOneEntityObject.)
	MatchesFilter(DataAccessFilter, IBufferRow)	Matches the filter against the specified row and returns the result of the match. (Inherited from EnterpriseOneEntityObject.)
	Refresh	Refreshes this instance with data from data source. Only objects with ObjectState equal to Unchanged are refreshed. (Inherited from EntityObject.)
	SetPassword	Sets the User's password
	ToString	Returns a String that represents this instance. (Inherited from EntityObject.)
	ToString(String)	Returns a String that represents this instance. (Inherited from EntityObject.)
	TryGet	Tries to get the specified attribute and returns it or null, when it is not found. (Inherited from DomainObject.)

Top

Extension Methods

	Name	Description
	FillAggregateMissingDefaults	Recalculates the default values for all objects in the aggregate. (Defined by EntityObjectExtensions.)
	FillMissingDefaults	Executes the late default expression defined in each attribute (if any) if the current value is null or equal to a constant default. (Defined by EntityObjectExtensions.)
	FormatString	Converts the object to string based on the format specified. (Defined by FormatStringExtensions.)
	GetExtensibleDataObject	Gets the extensible data object related to the entity object. Can return null if such ExtensibleDataObject doesn't exist. (Defined by ExtensibleDataObjectExtensions.)
	GetOrCreateExtensibleDataObject	Returns an ExtensibleDataObject related to the entity object. If such object doesn't exist the object is created in the same transaction. (Defined by ExtensibleDataObjectExtensions.)
	RecalculateMasterAttributes	Recalculates the values of a master attributes in a master-detail relationship. (Defined by EntityObjectExtensions.)
	RecalculateMissingValues	Recalculates the missing values using the first reactive expression of the attributes. (Defined by EntityObjectExtensions.)

Top

Reference

Aloe.EnterpriseOne.Model.Systems.Security Namespace