View Source

Class User

Represents a backoffice user

Inheritance

object

BeingDirtyBase

EntityBase

Namespace: Umbraco.Cms.Core.Models.Membership

Assembly: Umbraco.Core.dll

Syntax

[Serializable]
[DataContract(IsReference = true)]
public class User : EntityBase, IUser, IMembershipUser, IEntity, IDeepCloneable, IRememberBeingDirty, ICanBeDirty, IProfile

Constructors

User(GlobalSettings)

Constructor for creating a new/empty user

Declaration

public User(GlobalSettings globalSettings)

Parameters

Type	Name	Description
GlobalSettings	globalSettings

User(GlobalSettings, int, string?, string, string?, string?, string?, IEnumerable<IReadOnlyUserGroup>, int[], int[])

Constructor for creating a new User instance for an existing user

Declaration

public User(GlobalSettings globalSettings, int id, string? name, string email, string? username, string? rawPasswordValue, string? passwordConfig, IEnumerable<IReadOnlyUserGroup> userGroups, int[] startContentIds, int[] startMediaIds)

Parameters

Type	Name	Description
GlobalSettings	globalSettings
int	id
string	name
string	email
string	username
string	rawPasswordValue
string	passwordConfig
IEnumerable<IReadOnlyUserGroup>	userGroups
int[]	startContentIds
int[]	startMediaIds

User(GlobalSettings, string?, string, string, string)

Constructor for creating a new/empty user

Declaration

public User(GlobalSettings globalSettings, string? name, string email, string username, string rawPasswordValue)

Parameters

Type	Name	Description
GlobalSettings	globalSettings
string	name
string	email
string	username
string	rawPasswordValue

Properties

AllowedSections

Declaration

public IEnumerable<string> AllowedSections { get; }

Property Value

Type	Description
IEnumerable<string>

Avatar

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

Declaration

[DataMember]
public string? Avatar { get; set; }

Property Value

Type	Description
string

Comments

Declaration

[IgnoreDataMember]
public string? Comments { get; set; }

Property Value

Type	Description
string

Email

Declaration

[DataMember]
public string Email { get; set; }

Property Value

Type	Description
string

EmailConfirmedDate

Declaration

[DataMember]
public DateTime? EmailConfirmedDate { get; set; }

Property Value

Type	Description
DateTime?

FailedPasswordAttempts

Gets or sets the number of failed password attempts. This is the number of times the password was entered incorrectly upon login.

Declaration

[IgnoreDataMember]
public int FailedPasswordAttempts { get; set; }

Property Value

Type	Description
int

Remarks

Alias: umbracoMemberFailedPasswordAttempts Part of the standard properties collection.

Groups

Gets the groups that user is part of

Declaration

[DataMember]
public IEnumerable<IReadOnlyUserGroup> Groups { get; }

Property Value

Type	Description
IEnumerable<IReadOnlyUserGroup>

InvitedDate

Declaration

[DataMember]
public DateTime? InvitedDate { get; set; }

Property Value

Type	Description
DateTime?

IsApproved

Declaration

[DataMember]
public bool IsApproved { get; set; }

Property Value

Type	Description
bool

IsLockedOut

Declaration

[IgnoreDataMember]
public bool IsLockedOut { get; set; }

Property Value

Type	Description
bool

Kind

The type of user.

Declaration

[DataMember]
public UserKind Kind { get; set; }

Property Value

Type	Description
UserKind

Language

Declaration

[DataMember]
public string? Language { get; set; }

Property Value

Type	Description
string

LastLockoutDate

Declaration

[IgnoreDataMember]
public DateTime? LastLockoutDate { get; set; }

Property Value

Type	Description
DateTime?

LastLoginDate

Declaration

[IgnoreDataMember]
public DateTime? LastLoginDate { get; set; }

Property Value

Type	Description
DateTime?

LastPasswordChangeDate

Declaration

[IgnoreDataMember]
public DateTime? LastPasswordChangeDate { get; set; }

Property Value

Type	Description
DateTime?

Name

Declaration

[DataMember]
public string? Name { get; set; }

Property Value

Type	Description
string

PasswordConfiguration

The user's specific password config (i.e. algorithm type, etc...)

Declaration

[IgnoreDataMember]
public string? PasswordConfiguration { get; set; }

Property Value

Type	Description
string

ProfileData

Exposes the basic profile data

Declaration

public IProfile ProfileData { get; }

Property Value

Type	Description
IProfile

RawPasswordValue

Gets or sets the raw password value

Declaration

[IgnoreDataMember]
public string? RawPasswordValue { get; set; }

Property Value

Type	Description
string

SecurityStamp

The security stamp used by ASP.Net identity

Declaration

[IgnoreDataMember]
public string? SecurityStamp { get; set; }

Property Value

Type	Description
string

SessionTimeout

Gets or sets the session timeout.

Declaration

[DataMember]
public int SessionTimeout { get; set; }

Property Value

Type	Description
int	The session timeout.

StartContentIds

Gets or sets the start content id.

Declaration

[DataMember]
public int[]? StartContentIds { get; set; }

Property Value

Type	Description
int[]	The start content id.

StartMediaIds

Gets or sets the start media id.

Declaration

[DataMember]
public int[]? StartMediaIds { get; set; }

Property Value

Type	Description
int[]	The start media id.

UserState

Declaration

public UserState UserState { get; }

Property Value

Type	Description
UserState

Username

Declaration

[DataMember]
public string Username { get; set; }

Property Value

Type	Description
string

Methods

AddGroup(IReadOnlyUserGroup)

Declaration

public void AddGroup(IReadOnlyUserGroup group)

Parameters

Type	Name	Description
IReadOnlyUserGroup	group

ClearGroups()

Declaration

public void ClearGroups()

PerformDeepClone(object)

Used by inheritors to modify the DeepCloning logic

Declaration

protected override void PerformDeepClone(object clone)

Parameters

Type	Name	Description
object	clone

RemoveGroup(string)

Declaration

public void RemoveGroup(string group)

Parameters

Type	Name	Description
string	group