Class User

Inheritance
object
BaseEntity
BaseEntityWithPermissions
User
Implements
Inherited Members
Namespace: LemonEdge.API.Entities.Administration
Assembly: LemonEdge.API.Entities.Auto.dll
Syntax
[DataContract]
public class User : BaseEntityWithPermissions, IUser, IBaseEntityWithPermissions, IBaseEntity, IEquatable<IBaseEntity>, INotifyPropertyChanged, INotifyPropertyChanging, ICloneableAsync, ICanTrackProperties, ISetCopier, ICloneableAsync<IUser>

Constructors

User()

Declaration
public User()

Properties

AllowMultiLoginAsService

Indicates whether the user can be logged in from multiple devices at the same time (as when scaling a service account in a web service).

Declaration
public bool AllowMultiLoginAsService { get; set; }
Property Value
Type Description
bool

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
public Guid DefaultNotificationTypeID { get; set; }
Property Value
Type Description
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
[UserTeamValid]
public Guid DefaultTeamID { get; set; }
Property Value
Type Description
Guid

DefaultTeamID_Label

Declaration
public string DefaultTeamID_Label { get; set; }
Property Value
Type Description
string

DefaultTeamID_Label_Silent

Declaration
[NotMapped]
public string DefaultTeamID_Label_Silent { get; set; }
Property Value
Type Description
string

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
[Required]
[GlobalUniqueEmail]
[Unique]
[StringLength(500)]
public string EmailLogin { get; set; }
Property Value
Type Description
string

HashedAccessToken

The hashed access token for this user

Declaration
[StringLength(500)]
public string HashedAccessToken { get; set; }
Property Value
Type Description
string

HashedPassword

The hashed password for this user

Declaration
public byte[] HashedPassword { get; set; }
Property Value
Type Description
byte[]

LastIPAddress

The IP Address this user last logged in from

Declaration
[StringLength(32)]
public string LastIPAddress { get; set; }
Property Value
Type Description
string

LastLoggedInRoleID

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

Declaration
public Guid? LastLoggedInRoleID { get; set; }
Property Value
Type Description
Guid?

LastLoggedInRoleID_Label

Declaration
public string LastLoggedInRoleID_Label { get; set; }
Property Value
Type Description
string

LastLoggedInRoleID_Label_Silent

Declaration
[NotMapped]
public string LastLoggedInRoleID_Label_Silent { get; set; }
Property Value
Type Description
string

LastLogin

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

Declaration
public DateTimeOffset? LastLogin { get; set; }
Property Value
Type Description
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
public bool LockInCanvas { get; set; }
Property Value
Type Description
bool

LockInSafe

Indicates the user is locked into running in this safe only, they can not create items in the main system

Declaration
public bool LockInSafe { get; set; }
Property Value
Type Description
bool

LogQueryStats

Indicates query stats should be logged (Default) by this user. Can be turned off for migration users, or large import users for performance of complex calculations.

Declaration
public bool LogQueryStats { get; set; }
Property Value
Type Description
bool

Name

The unique user friendly name of this user

Declaration
[Required]
[StringLength(500)]
public string Name { get; set; }
Property Value
Type Description
string

NotificationEmailOverride

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

Declaration
[StringLength(500)]
public string NotificationEmailOverride { get; set; }
Property Value
Type Description
string

PromoteOnlyWithTeamID

Links to ITeam. Indicates the team permissions to use only when promoting items from a canvas - not necessarily a team the user has access to otherwise

Declaration
public Guid? PromoteOnlyWithTeamID { get; set; }
Property Value
Type Description
Guid?

PromoteOnlyWithTeamID_Label

Declaration
public string PromoteOnlyWithTeamID_Label { get; set; }
Property Value
Type Description
string

PromoteOnlyWithTeamID_Label_Silent

Declaration
[NotMapped]
public string PromoteOnlyWithTeamID_Label_Silent { get; set; }
Property Value
Type Description
string

RunInCanvasID

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

Declaration
public Guid? RunInCanvasID { get; set; }
Property Value
Type Description
Guid?

RunInCanvasID_Label

Declaration
public string RunInCanvasID_Label { get; set; }
Property Value
Type Description
string

RunInCanvasID_Label_Silent

Declaration
[NotMapped]
public string RunInCanvasID_Label_Silent { get; set; }
Property Value
Type Description
string

RunInSafeID

Links to ISafe. Indicates the user is currently running within the specified safe, meaning any created items by the user automatically belong in that safe

Declaration
[UserSafeValid]
public Guid? RunInSafeID { get; set; }
Property Value
Type Description
Guid?

RunInSafeID_Label

Declaration
public string RunInSafeID_Label { get; set; }
Property Value
Type Description
string

RunInSafeID_Label_Silent

Declaration
[NotMapped]
public string RunInSafeID_Label_Silent { get; set; }
Property Value
Type Description
string

SessionID

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

Declaration
public Guid? SessionID { get; set; }
Property Value
Type Description
Guid?

SessionStart

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

Declaration
public DateTimeOffset? SessionStart { get; set; }
Property Value
Type Description
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
public bool Suspended { get; set; }
Property Value
Type Description
bool

UITheme

The default theme for the user client application

Declaration
[EnumDataType(typeof(Theme))]
public Theme UITheme { get; set; }
Property Value
Type Description
Theme

UITheme_Tooltip

Declaration
[NotMapped]
public string UITheme_Tooltip { get; set; }
Property Value
Type Description
string

ValidFrom

The date/time this users login is valid from. If set they will not be able to login until this date/time has passed.

Declaration
public DateTimeOffset? ValidFrom { get; set; }
Property Value
Type Description
DateTimeOffset?

ValidTo

The date/time this users login is valid to. If set they will not be able to login after this date/time.

Declaration
public DateTimeOffset? ValidTo { get; set; }
Property Value
Type Description
DateTimeOffset?

WindowsLoginDomain

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

Declaration
[StringLength(500)]
public string WindowsLoginDomain { get; set; }
Property Value
Type Description
string

WindowsLoginOnly

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

Declaration
public bool WindowsLoginOnly { get; set; }
Property Value
Type Description
bool

Methods

ClientUnSafeProperties()

Declaration
public static IEnumerable<string> ClientUnSafeProperties()
Returns
Type Description
IEnumerable<string>

CopyFromEntity(IBaseEntity)

Declaration
protected override void CopyFromEntity(IBaseEntity src)
Parameters
Type Name Description
IBaseEntity src
Overrides

CopyFromSource(IUser)

Updates all properties in this item to have the same properties as the source object.

Declaration
public void CopyFromSource(IUser source)
Parameters
Type Name Description
IUser source

The source object to copy all values from.

DoPasswordsMatch(byte[], byte[])

Declaration
public static bool DoPasswordsMatch(byte[] encryptedPassword, byte[] encryptedPassword2)
Parameters
Type Name Description
byte[] encryptedPassword
byte[] encryptedPassword2
Returns
Type Description
bool

DoPasswordsMatch(Guid, byte[], string)

Declaration
public static bool DoPasswordsMatch(Guid userID, byte[] encryptedPassword, string encryptedPassword2)
Parameters
Type Name Description
Guid userID
byte[] encryptedPassword
string encryptedPassword2
Returns
Type Description
bool

EncryptPassword(Guid, string)

Encrypts the specified text user password

Declaration
public static byte[] EncryptPassword(Guid saltUserID, string rawPassword)
Parameters
Type Name Description
Guid saltUserID

The user id providing a salt for each password that is the same
string rawPassword

The raw unencrypted user password
Returns
Type Description
byte[]

An encrypted user password

EncryptPasswordToBase64(Guid, string)

Encrypts the specified text user password

Declaration
public static string EncryptPasswordToBase64(Guid saltUserID, string rawPassword)
Parameters
Type Name Description
Guid saltUserID

The user id providing a salt for each password that is the same
string rawPassword

The raw unencrypted user password
Returns
Type Description
string

An encrypted user password

ToString()

Declaration
public override string ToString()
Returns
Type Description
string
Overrides

Implements

Extension Methods