Interface IUser

The system entity for a user.

See https://web.lemonedge.com/help/users/ for more information

Inherited Members
System.IEquatable<LemonEdge.API.Core.IBaseEntity>.Equals(LemonEdge.API.Core.IBaseEntity)
System.ComponentModel.INotifyPropertyChanged.PropertyChanged
System.ComponentModel.INotifyPropertyChanging.PropertyChanging
Namespace: LemonEdge.API.Entities
Assembly: API.dll
Syntax
[EntityDefinition(EntityID.Users, "dbo.LT_Users", "User", LabelColumn = "EmailLogin", CustomToString = true, SelectWithNoLock = true, HelpURL = "users")]
[DefaultEntityIcon(ImageType.User)]
public interface IUser : IBaseEntityWithPermissions, IBaseEntity, IEquatable<IBaseEntity>, INotifyPropertyChanged, INotifyPropertyChanging, ICloneableAsync, ICanTrackProperties, ISetCopier

Properties

DefaultNotificationTypeID

The default method the system uses to notify the user. You can have other custom notification methods if you've implemented the INotificationType interface in our API.

Declaration
[EntityDescription("The default method the system uses to notify the user. You can have other custom notification methods if you've implemented the IWatcherNotificationType interface in our API.")]
[EntityProperty(SQLType.UniqueIdentifier, false, "'A756452F-2E7C-4D9F-A92A-AF97AC07B004'")]
[HardCodedDefaultValueOnNew("A756452F-2E7C-4D9F-A92A-AF97AC07B004")]
Guid DefaultNotificationTypeID { get; set; }
Property Value
Type Description
System.Guid

DefaultTeamID

Links to ITeam. The current teams set of permissions that the user is running the system under.

A user must be a member of at least one team otherwise they will be unable to login.

Declaration
[EntityDescription("The current teams set of permissions that the user is running the system under. A user must be a member of at least one team otherwise they will be unable to login.")]
[EntityProperty(SQLType.UniqueIdentifier, false)]
[EntityRelationship(EntityID.Teams, "ID", SingleJoinType.One, "Default Team", "Users Default Teams", LinkToItemInSet = false, PreventAutoConstraint = true)]
Guid DefaultTeamID { get; set; }
Property Value
Type Description
System.Guid

EmailLogin

[Key] The unique login for this user - normally an email address.

The system will use this as the default email for notifications if required.

Declaration
[EntityDescription("The globally unique login for this user - normally an email address.")]
[EntityProperty(SQLType.NVarChar, (short)500, false)]
[Required]
string EmailLogin { get; set; }
Property Value
Type Description
System.String

HashedPassword

The hashed password for this user

Declaration
[EntityProperty(SQLType.VarBinary, false)]
byte[] HashedPassword { get; set; }
Property Value
Type Description
System.Byte[]

LastIPAddress

The IP Address this user last logged in from

Declaration
[EntityDescription("The IP Address this user last logged in from")]
[EntityProperty(SQLType.NVarChar, (short)32, true)]
string LastIPAddress { get; set; }
Property Value
Type Description
System.String

LastLoggedInRoleID

Links to IRole. Indicates the role the user is currently running the system in.

Declaration
[EntityDescription("Indicates the role the user is currently running the system in.")]
[EntityProperty(SQLType.UniqueIdentifier, true)]
[EntityRelationship(EntityID.Roles, "ID", SingleJoinType.ZeroToOne, "Last Logged In Role", "Users Last Logged In", LinkToItemInSet = false)]
Guid? LastLoggedInRoleID { get; set; }
Property Value
Type Description
System.Nullable<System.Guid>

LastLogin

The date/time of the last successful login of this user

Declaration
[EntityDescription("The date/time of the last successful login of this user")]
[EntityProperty(SQLType.DateTimeOffset, true)]
DateTimeOffset? LastLogin { get; set; }
Property Value
Type Description
System.Nullable<System.DateTimeOffset>

LockInCanvas

Indicates the user is locked into running in this canvas only, they can not log into the main system or any other canvas.

Declaration
[EntityDescription("Indicates the user is locked into running in this canvas only, they can not log into the main system or any other canvas.")]
[EntityProperty(SQLType.Bit, false, "0")]
bool LockInCanvas { get; set; }
Property Value
Type Description
System.Boolean

Name

The unique user friendly name of this user

Declaration
[EntityProperty(SQLType.NVarChar, (short)500, false)]
[EntityDescription("The unique user friendly name of this user")]
[Required]
string Name { get; set; }
Property Value
Type Description
System.String

NotificationEmailOverride

By default email notifications will use the users EmailLogin. This can override that with another email address instead.

Declaration
[EntityDescription("By default email notifications will use the users EmailLogin. This can override that with another email address instead.")]
[EntityProperty(SQLType.NVarChar, (short)500, true)]
string NotificationEmailOverride { get; set; }
Property Value
Type Description
System.String

RunInCanvasID

Links to ICanvas. Indicates the user is currently running exclusively within the specified canvas

Declaration
[EntityDescription("Indicates the user is currently running exclusively within the specified canvas")]
[EntityProperty(SQLType.UniqueIdentifier, true)]
[EntityRelationship(EntityID.Canvas, "ID", SingleJoinType.ZeroToOne, "Running In Canvas", "Canvases In Use By Users", LinkToItemInSet = false)]
Guid? RunInCanvasID { get; set; }
Property Value
Type Description
System.Nullable<System.Guid>

SessionID

The unique session id this user is currently running under from their login

Declaration
[EntityProperty(SQLType.UniqueIdentifier, true)]
Guid? SessionID { get; set; }
Property Value
Type Description
System.Nullable<System.Guid>

SessionStart

The date/time the session started, so it can automatically be invalidated after a period of time

Declaration
[EntityProperty(SQLType.DateTimeOffset, true)]
DateTimeOffset? SessionStart { get; set; }
Property Value
Type Description
System.Nullable<System.DateTimeOffset>

Suspended

Indicates this user is suspended.

If they are suspended the user will not be able to login, but any attempts are still audited.

Declaration
[EntityDescription("Indicates this user is suspended. If they are suspended the user will not be able to login, but any attempts are still audited.")]
[EntityProperty(SQLType.Bit, false, "0")]
bool Suspended { get; set; }
Property Value
Type Description
System.Boolean

UITheme

The default theme for the user client application

Declaration
[EntityDescription("The default theme for the user client application")]
[EntityProperty(SQLType.SmallInt, false, "24")]
[HardCodedDefaultValueOnNew("24")]
Theme UITheme { get; set; }
Property Value
Type Description
Theme

WindowsLoginDomain

The users windows login domain and user for logging in using windows credentials

Declaration
[EntityDescription("The users windows login domain and user for logging in using windows credentials.")]
[EntityProperty(SQLType.NVarChar, (short)500, true)]
string WindowsLoginDomain { get; set; }
Property Value
Type Description
System.String

WindowsLoginOnly

Indicates if users can only login using their windows crednetials or not.

Declaration
[EntityDescription("Indicates if users can only login using their windows crednetials or not.")]
[EntityProperty(SQLType.Bit, false, "0")]
bool WindowsLoginOnly { get; set; }
Property Value
Type Description
System.Boolean

Extension Methods

See Also