Interface IAccountMaintenance
The entity for account maintenance.
This enables maintenance of the multi-tenanted accounts in the database. Can only be modified from the root account itself.
See https://web.lemonedge.com/help/account-maintenance/ for more informationInherited Members
Namespace: LemonEdge.API.Entities
Assembly: API.dll
Syntax
[EntityDefinition(EntityID.AccountMaintenance, "dbo.LT_AccountMaintenance", "AccountMaintenance", LabelColumn = "Name", IsStandingDataEntity = true, HelpURL = "account-maintenance")]
[DefaultEntityIcon(ImageType.Maintenance)]
public interface IAccountMaintenance : IBaseEntityWithPermissions, ISetCopier, IShareAcrossAccounts, IBaseEntity, IEquatable<IBaseEntity>, INotifyPropertyChanged, INotifyPropertyChanging, ICloneableAsync, ICanTrackProperties, ILicense
Properties
AdminUserID
Links to IUser. Holds the unique ID of the admin of this account. Can't be linked to, as this exists in the account itself and is administered from the root account (1).
Declaration
[EntityProperty(SQLType.UniqueIdentifier, true)]
[EntityDescription("Holds the unique ID of the admin of this account. Can't be linked to, as this exists in the account itself and is administered from the root account (1).")]
Guid? AdminUserID { get; set; }
Property Value
Type | Description |
---|---|
System.Nullable<System.Guid> |
CanEditSQL
Indicates this is account is permitted to edit SQL manually in sql wrappers.
Declaration
[EntityProperty(SQLType.Bit, false, "0")]
[EntityDescription("Indicates this is account is permitted to edit SQL manually in sql wrappers.")]
bool CanEditSQL { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
Description
A user friendly description of this account
Declaration
[EntityProperty(SQLType.NVarChar, (short)2000, true)]
[EntityDescription("A user friendly description of this account.")]
string Description { get; set; }
Property Value
Type | Description |
---|---|
System.String |
LicenseKey
This holds a valid license key for this account.
Declaration
[EntityProperty(SQLType.NVarChar, (short)2500, true)]
[EntityDescription("This holds a valid license key for this account.")]
string LicenseKey { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Name
The user friendly name of this account.
Declaration
[EntityProperty(SQLType.NVarChar, (short)500, false)]
[EntityDescription("The unique name of this Account.")]
[Required]
string Name { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Suspended
Indicates if this account is suspended. If it is then no-one can log into this account.
Declaration
[EntityProperty(SQLType.Bit, false, "0")]
[EntityDescription("Indicates if this account is suspended. If so no user can log into it, no services will run for it.")]
[PropertyValidation("MyItem.Suspended == true", "MyItem.UniqueAccountID != 1", "You can not suspend the main root account.")]
bool Suspended { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
SystemHelpURL
Holds the help url for this system. Defaults to the base help url if empty.
Declaration
[EntityProperty(SQLType.NVarChar, (short)2500, true)]
[EntityDescription("Holds the help url for this system. Defaults to the base help url if empty.")]
string SystemHelpURL { get; set; }
Property Value
Type | Description |
---|---|
System.String |
UniqueAccountID
The unique account id for this account.
The main root account always has an id of 1.
This is the key for this entityDeclaration
[EntityProperty(SQLType.BigInt, false, "1")]
[EntityAutoIncrementColumn(2)]
[EntityDescription("Holds the unique id for this account.")]
[EntitySequence]
[PropertyValidation("MyItem.AccountID != 1", "false", "Accounts can only be maintained from within the root account itself.")]
long UniqueAccountID { get; set; }
Property Value
Type | Description |
---|---|
System.Int64 |