View Source

Class BackOfficeIdentityUser

The identity user used for the back office

Inheritance

object

IdentityUser<string>

IdentityUser

UmbracoIdentityUser

Namespace: Umbraco.Cms.Core.Security

Assembly: Umbraco.Infrastructure.dll

Syntax

public class BackOfficeIdentityUser : UmbracoIdentityUser, IRememberBeingDirty, ICanBeDirty

Constructors

BackOfficeIdentityUser(GlobalSettings, int, IEnumerable<IReadOnlyUserGroup>)

Initializes a new instance of the BackOfficeIdentityUser class.

Declaration

public BackOfficeIdentityUser(GlobalSettings globalSettings, int userId, IEnumerable<IReadOnlyUserGroup> groups)

Parameters

Type	Name	Description
GlobalSettings	globalSettings
int	userId
IEnumerable<IReadOnlyUserGroup>	groups

Properties

AllowedSections

Gets a readonly list of the user's allowed sections which are based on it's user groups

Declaration

public string[] AllowedSections { get; }

Property Value

Type	Description
string[]

CalculatedContentStartNodeIds

Declaration

public int[]? CalculatedContentStartNodeIds { get; set; }

Property Value

Type	Description
int[]

CalculatedMediaStartNodeIds

Declaration

public int[]? CalculatedMediaStartNodeIds { get; set; }

Property Value

Type	Description
int[]

Culture

Gets or sets the culture

Declaration

public string Culture { get; set; }

Property Value

Type	Description
string

InviteDate

Gets or sets invite date

Declaration

public DateTime? InviteDate { get; set; }

Property Value

Type	Description
DateTime?

Key

Declaration

public Guid Key { get; set; }

Property Value

Type	Description
Guid

Kind

Declaration

public UserKind Kind { get; set; }

Property Value

Type	Description
UserKind

StartContentIds

Gets or sets content start nodes assigned to the User (not ones assigned to the user's groups)

Declaration

public int[] StartContentIds { get; set; }

Property Value

Type	Description
int[]

StartMediaIds

Gets or sets media start nodes assigned to the User (not ones assigned to the user's groups)

Declaration

public int[] StartMediaIds { get; set; }

Property Value

Type	Description
int[]

Methods

CreateNew(GlobalSettings, string?, string, string, string?, Guid?, UserKind)

Used to construct a new instance without an identity

Declaration

public static BackOfficeIdentityUser CreateNew(GlobalSettings globalSettings, string? username, string email, string culture, string? name = null, Guid? id = null, UserKind kind = UserKind.Default)

Parameters

Type	Name	Description
GlobalSettings	globalSettings
string	username
string	email	This is allowed to be null (but would need to be filled in if trying to persist this instance)
string	culture
string	name
Guid?	id
UserKind	kind

Returns

Type	Description
BackOfficeIdentityUser

SetGroups(IReadOnlyCollection<IReadOnlyUserGroup>)

Gets or sets the user groups

Declaration

public void SetGroups(IReadOnlyCollection<IReadOnlyUserGroup> value)

Parameters

Type	Name	Description
IReadOnlyCollection<IReadOnlyUserGroup>	value