NamespaceSystemLibrary.Common.Episerver.Users SystemLibrary.Common.Episerver.dll

CurrentUser can be injected or 'new CurrentUser()' whenever you need it

Remember: to use 'CurrentUser' as an injected object, you must call 'AddCommonCmsServices<CurrentUser>(...);' or similar

CurrentUser

public class CurrentUser : ApplicationUser, IUIUser

Inheritance

System.Object

Microsoft.AspNetCore.Identity.IdentityUser<System.String>

Microsoft.AspNetCore.Identity.IdentityUser

EPiServer.Cms.UI.AspNetIdentity.ApplicationUser

CurrentUser

Implements

EPiServer.Shell.Security.IUIUser

Inherited Members

EPiServer.Cms.UI.AspNetIdentity.ApplicationUser.IsApproved

EPiServer.Cms.UI.AspNetIdentity.ApplicationUser.IsLockedOut

EPiServer.Cms.UI.AspNetIdentity.ApplicationUser.PasswordQuestion

EPiServer.Cms.UI.AspNetIdentity.ApplicationUser.ProviderName

EPiServer.Cms.UI.AspNetIdentity.ApplicationUser.Comment

EPiServer.Cms.UI.AspNetIdentity.ApplicationUser.CreationDate

EPiServer.Cms.UI.AspNetIdentity.ApplicationUser.LastLoginDate

EPiServer.Cms.UI.AspNetIdentity.ApplicationUser.LastLockoutDate

EPiServer.Cms.UI.AspNetIdentity.ApplicationUser.Username

Microsoft.AspNetCore.Identity.IdentityUser<System.String>.ToString()

Microsoft.AspNetCore.Identity.IdentityUser<System.String>.Id

Microsoft.AspNetCore.Identity.IdentityUser<System.String>.UserName

Microsoft.AspNetCore.Identity.IdentityUser<System.String>.NormalizedUserName

Microsoft.AspNetCore.Identity.IdentityUser<System.String>.Email

Microsoft.AspNetCore.Identity.IdentityUser<System.String>.NormalizedEmail

Microsoft.AspNetCore.Identity.IdentityUser<System.String>.EmailConfirmed

Microsoft.AspNetCore.Identity.IdentityUser<System.String>.PasswordHash

Microsoft.AspNetCore.Identity.IdentityUser<System.String>.SecurityStamp

Microsoft.AspNetCore.Identity.IdentityUser<System.String>.ConcurrencyStamp

Microsoft.AspNetCore.Identity.IdentityUser<System.String>.PhoneNumber

Microsoft.AspNetCore.Identity.IdentityUser<System.String>.PhoneNumberConfirmed

Microsoft.AspNetCore.Identity.IdentityUser<System.String>.TwoFactorEnabled

Microsoft.AspNetCore.Identity.IdentityUser<System.String>.LockoutEnd

Microsoft.AspNetCore.Identity.IdentityUser<System.String>.LockoutEnabled

Microsoft.AspNetCore.Identity.IdentityUser<System.String>.AccessFailedCount

Examples

X

// Implement your own CurrentUser object by inheriting 'CurrentUser'

public class AppUser : CurrentUser
{
    public string PhoneNumber => Claim<string>("PhoneNumber");
}

// Register user class within ConfigureServices() at startup:
public void ConfigureServices(IServiceCollection services)
{
    services.AddCommonCmsServices<AppUser, ...>(...);
}

// Use your AppUser anywhere you'd like
public ActionResult Index()
{
    var user = new AppUser();
    user.IsAdministrator || user.IsCmsUser
}

Arguments

X

Properties

First name taken from claim 'GivenName'

public string GivenName { get; }

X

Property Value

Type	Description
System.String

Returns true if current user is logged in and is in any of the admin roles: CmsAdmins, WebAdmins, Administrators

public bool IsAdministrator { get; }

X

Property Value

Type	Description
System.Boolean

public bool IsAuthenticated { get; }

X

Property Value

Type	Description
System.Boolean

Returns true if current user is logged in and is in any of the roles: CmsAdmin, WebAdmins, Administrators, CmsEditors, WebEditors

public bool IsCmsUser { get; }

X

Property Value

Type	Description
System.Boolean

Name of the Principal Identity

public string Name { get; }

X

Property Value

Type	Description
System.String

Last name taken from claim 'Surname'

public string Surname { get; }

X

Property Value

Type	Description
System.String

Methods

public T Claim<T>(string claim, T defaultValue = null)

X

Generic types

Name	Description
T

Methods arguments

Type	Name	Description
System.String	claim
T	defaultValue

X

Type	Description
T

Returns true if current user is logged in and is in the role specified

• Checking for an 'unauthenticated role' does not work

public bool IsInRole(string roleName)

X

Methods arguments

Type	Name	Description
System.String	roleName

X

Type	Description
System.Boolean

Implements

EPiServer.Shell.Security.IUIUser

Extension Methods

TExtensions.ReactServerSideRender<T>(T, Object, String, Boolean, String, String, String, Boolean, Boolean, Boolean)

}