View Source

Class UserDto

Data transfer object representing a user in the Umbraco CMS persistence layer.

Inheritance

object

Namespace: Umbraco.Cms.Infrastructure.Persistence.Dtos

Assembly: Umbraco.Infrastructure.dll

Syntax

public class UserDto

Constructors

UserDto()

Initializes a new instance of the UserDto class with default values.

Declaration

public UserDto()

Fields

KeyColumnName

Declaration

public const string KeyColumnName = "key"

Field Value

Type	Description
string

PrimaryKeyColumnName

Declaration

public const string PrimaryKeyColumnName = "id"

Field Value

Type	Description
string

TableName

Declaration

public const string TableName = "umbracoUser"

Field Value

Type	Description
string

Properties

Avatar

Will hold the media file system relative path of the users custom avatar if they uploaded one

Declaration

[NullSetting(NullSetting = NullSettings.Null)]
[Length(500)]
public string? Avatar { get; set; }

Property Value

Type	Description
string

CreateDate

Gets or sets the date and time when the user was created.

Declaration

[NullSetting(NullSetting = NullSettings.NotNull)]
[Constraint(Default = SystemMethods.CurrentUTCDateTime)]
public DateTime CreateDate { get; set; }

Property Value

Type	Description
DateTime

Disabled

Gets or sets a value indicating whether the user is disabled.

Declaration

[Constraint(Default = "0")]
public bool Disabled { get; set; }

Property Value

Type	Description
bool

Email

Gets or sets the email address of the user.

Declaration

public string Email { get; set; }

Property Value

Type	Description
string

EmailConfirmedDate

Gets or sets the date and time when the user's email was confirmed.

Declaration

[NullSetting(NullSetting = NullSettings.Null)]
public DateTime? EmailConfirmedDate { get; set; }

Property Value

Type	Description
DateTime?

FailedLoginAttempts

Gets or sets the number of failed login attempts.

Declaration

[NullSetting(NullSetting = NullSettings.Null)]
public int? FailedLoginAttempts { get; set; }

Property Value

Type	Description
int?

Id

Gets or sets the unique identifier for the user.

Declaration

[PrimaryKeyColumn(Name = "PK_user")]
public int Id { get; set; }

Property Value

Type	Description
int

InvitedDate

Gets or sets the date when the user was invited.

Declaration

[NullSetting(NullSetting = NullSettings.Null)]
public DateTime? InvitedDate { get; set; }

Property Value

Type	Description
DateTime?

Key

Gets or sets the unique GUID key that identifies the user.

Declaration

[NullSetting(NullSetting = NullSettings.NotNull)]
[Constraint(Default = SystemMethods.NewGuid)]
[Index(IndexTypes.UniqueNonClustered, Name = "IX_umbracoUser_userKey")]
public Guid Key { get; set; }

Property Value

Type	Description
Guid

Kind

Gets or sets the kind of the user, typically used to distinguish between different user types or roles within the system.

Declaration

[NullSetting(NullSetting = NullSettings.NotNull)]
[Constraint(Default = 0)]
public short Kind { get; set; }

Property Value

Type	Description
short

LastLockoutDate

Gets or sets the date and time when the user was last locked out.

Declaration

[NullSetting(NullSetting = NullSettings.Null)]
public DateTime? LastLockoutDate { get; set; }

Property Value

Type	Description
DateTime?

LastLoginDate

Gets or sets the date and time when the user last logged in.

Declaration

[NullSetting(NullSetting = NullSettings.Null)]
public DateTime? LastLoginDate { get; set; }

Property Value

Type	Description
DateTime?

LastPasswordChangeDate

Gets or sets the date and time when the user's password was last changed.

Declaration

[NullSetting(NullSetting = NullSettings.Null)]
public DateTime? LastPasswordChangeDate { get; set; }

Property Value

Type	Description
DateTime?

Login

Gets or sets the username used for logging in to the user account.

Declaration

[Length(125)]
[Index(IndexTypes.NonClustered)]
public string? Login { get; set; }

Property Value

Type	Description
string

NoConsole

Gets or sets a value indicating whether the user is prevented from accessing the console.

Declaration

[Constraint(Default = "0")]
public bool NoConsole { get; set; }

Property Value

Type	Description
bool

Password

Gets or sets the user's hashed password. This value should never contain the plain text password.

Declaration

[Length(500)]
public string? Password { get; set; }

Property Value

Type	Description
string

PasswordConfig

This will represent a JSON structure of how the password has been created (i.e hash algorithm, iterations)

Declaration

[NullSetting(NullSetting = NullSettings.Null)]
[Length(500)]
public string? PasswordConfig { get; set; }

Property Value

Type	Description
string

SecurityStampToken

Gets or sets the security stamp token for the user, which is used to validate the user's security credentials and detect changes such as password updates.

Declaration

[NullSetting(NullSetting = NullSettings.Null)]
[Length(255)]
public string? SecurityStampToken { get; set; }

Property Value

Type	Description
string

UpdateDate

Gets or sets the date and time when the user was last updated.

Declaration

[NullSetting(NullSetting = NullSettings.NotNull)]
[Constraint(Default = SystemMethods.CurrentUTCDateTime)]
public DateTime UpdateDate { get; set; }

Property Value

Type	Description
DateTime

UserGroupDtos

Gets or sets the user groups associated with this user.

Declaration

public List<UserGroupDto> UserGroupDtos { get; set; }

Property Value

Type	Description
List<UserGroupDto>

UserLanguage

Gets or sets the ISO language code representing the user's preferred language.

Declaration

[NullSetting(NullSetting = NullSettings.Null)]
[Length(10)]
public string? UserLanguage { get; set; }

Property Value

Type	Description
string

UserName

Gets or sets the unique user name associated with the user.

Declaration

public string UserName { get; set; }

Property Value

Type	Description
string

UserStartNodeDtos

Gets or sets the collection of start node DTOs associated with the user.

Declaration

public HashSet<UserStartNodeDto> UserStartNodeDtos { get; set; }

Property Value

Type	Description
HashSet<UserStartNodeDto>