Class UmbracoBackOfficeIdentity

A custom user identity for the Umbraco backoffice

Inheritance

System.Object

System.Security.Claims.ClaimsIdentity

Namespace: Umbraco.Core.Security

Assembly: Umbraco.Core.dll

Syntax

[Serializable]
public class UmbracoBackOfficeIdentity : ClaimsIdentity, IIdentity

Remarks

This inherits from FormsIdentity for backwards compatibility reasons since we still support the forms auth cookie, in v8 we can change over to 'pure' asp.net identity and just inherit from ClaimsIdentity.

Constructors

View Source

UmbracoBackOfficeIdentity(Int32, String, String, IEnumerable<Int32>, IEnumerable<Int32>, String, String, String, IEnumerable<String>, IEnumerable<String>)

Creates a new UmbracoBackOfficeIdentity

Declaration

public UmbracoBackOfficeIdentity(int userId, string username, string realName, IEnumerable<int> startContentNodes, IEnumerable<int> startMediaNodes, string culture, string sessionId, string securityStamp, IEnumerable<string> allowedApps, IEnumerable<string> roles)

Parameters

Type	Name	Description
System.Int32	userId
System.String	username
System.String	realName
System.Collections.Generic.IEnumerable<System.Int32>	startContentNodes
System.Collections.Generic.IEnumerable<System.Int32>	startMediaNodes
System.String	culture
System.String	sessionId
System.String	securityStamp
System.Collections.Generic.IEnumerable<System.String>	allowedApps
System.Collections.Generic.IEnumerable<System.String>	roles

View Source

UmbracoBackOfficeIdentity(ClaimsIdentity, Int32, String, String, IEnumerable<Int32>, IEnumerable<Int32>, String, String, String, IEnumerable<String>, IEnumerable<String>)

Creates a new UmbracoBackOfficeIdentity

Declaration

public UmbracoBackOfficeIdentity(ClaimsIdentity childIdentity, int userId, string username, string realName, IEnumerable<int> startContentNodes, IEnumerable<int> startMediaNodes, string culture, string sessionId, string securityStamp, IEnumerable<string> allowedApps, IEnumerable<string> roles)

Parameters

Type	Name	Description
System.Security.Claims.ClaimsIdentity	childIdentity	The original identity created by the ClaimsIdentityFactory
System.Int32	userId
System.String	username
System.String	realName
System.Collections.Generic.IEnumerable<System.Int32>	startContentNodes
System.Collections.Generic.IEnumerable<System.Int32>	startMediaNodes
System.String	culture
System.String	sessionId
System.String	securityStamp
System.Collections.Generic.IEnumerable<System.String>	allowedApps
System.Collections.Generic.IEnumerable<System.String>	roles

Fields

View Source

Issuer

Declaration

public const string Issuer = "UmbracoBackOffice"

Field Value

Type	Description
System.String

Properties

View Source

AllowedApplications

Declaration

public string[] AllowedApplications { get; }

Property Value

Type	Description
System.String[]

View Source

AuthenticationType

Gets the type of authenticated identity.

Declaration

public override string AuthenticationType { get; }

Property Value

Type	Description
System.String	The type of authenticated identity. This property always returns "UmbracoBackOffice".

View Source

Culture

Declaration

public string Culture { get; }

Property Value

Type	Description
System.String

View Source

Id

Declaration

public int Id { get; }

Property Value

Type	Description
System.Int32

View Source

RealName

Declaration

public string RealName { get; }

Property Value

Type	Description
System.String

View Source

RequiredBackOfficeIdentityClaimTypes

Returns the required claim types for a back office identity

Declaration

public static IEnumerable<string> RequiredBackOfficeIdentityClaimTypes { get; }

Property Value

Type	Description
System.Collections.Generic.IEnumerable<System.String>

Remarks

This does not include the role claim type or allowed apps type since that is a collection and in theory could be empty

View Source

Roles

Declaration

public string[] Roles { get; }

Property Value

Type	Description
System.String[]

View Source

SecurityStamp

Declaration

public string SecurityStamp { get; }

Property Value

Type	Description
System.String

View Source

SessionId

Declaration

public string SessionId { get; set; }

Property Value

Type	Description
System.String

View Source

StartContentNodes

Declaration

public int[] StartContentNodes { get; }

Property Value

Type	Description
System.Int32[]

View Source

StartMediaNodes

Declaration

public int[] StartMediaNodes { get; }

Property Value

Type	Description
System.Int32[]

View Source

Username

Declaration

public string Username { get; }

Property Value

Type	Description
System.String

Methods

View Source

FromClaimsIdentity(ClaimsIdentity)

Declaration

public static UmbracoBackOfficeIdentity FromClaimsIdentity(ClaimsIdentity identity)

Parameters

Type	Name	Description
System.Security.Claims.ClaimsIdentity	identity

Returns

Type	Description
UmbracoBackOfficeIdentity