View Source

Class UsersController

Inheritance

System.Object

Microsoft.AspNetCore.Mvc.ControllerBase

UmbracoApiControllerBase

UmbracoApiController

UmbracoAuthorizedApiController

UmbracoAuthorizedJsonController

BackOfficeNotificationsController

Namespace: Umbraco.Cms.Web.BackOffice.Controllers

Assembly: Umbraco.Web.BackOffice.dll

Syntax

[PluginController(null)]
[Authorize(Policy = "SectionAccessUsers")]
[PrefixlessBodyModelValidator]
public class UsersController : BackOfficeNotificationsController, IUmbracoFeature, IDiscoverable

Constructors

UsersController(MediaFileManager, IOptions<ContentSettings>, IHostingEnvironment, ISqlContext, IImageUrlGenerator, IOptions<SecuritySettings>, IEmailSender, IBackOfficeSecurityAccessor, AppCaches, IShortStringHelper, IUserService, ILocalizedTextService, IUmbracoMapper, IOptions<GlobalSettings>, IBackOfficeUserManager, ILoggerFactory, LinkGenerator, IBackOfficeExternalLoginProviders, UserEditorAuthorizationHelper, IPasswordChanger<BackOfficeIdentityUser>)

Declaration

[Obsolete("Use constructor that also takes IHttpAccessor and IOptions<WebRoutingSettings>, scheduled for removal in V11")]
public UsersController(MediaFileManager mediaFileManager, IOptions<ContentSettings> contentSettings, IHostingEnvironment hostingEnvironment, ISqlContext sqlContext, IImageUrlGenerator imageUrlGenerator, IOptions<SecuritySettings> securitySettings, IEmailSender emailSender, IBackOfficeSecurityAccessor backofficeSecurityAccessor, AppCaches appCaches, IShortStringHelper shortStringHelper, IUserService userService, ILocalizedTextService localizedTextService, IUmbracoMapper umbracoMapper, IOptions<GlobalSettings> globalSettings, IBackOfficeUserManager backOfficeUserManager, ILoggerFactory loggerFactory, LinkGenerator linkGenerator, IBackOfficeExternalLoginProviders externalLogins, UserEditorAuthorizationHelper userEditorAuthorizationHelper, IPasswordChanger<BackOfficeIdentityUser> passwordChanger)

Parameters

Type	Name	Description
MediaFileManager	mediaFileManager
Microsoft.Extensions.Options.IOptions<ContentSettings>	contentSettings
IHostingEnvironment	hostingEnvironment
ISqlContext	sqlContext
IImageUrlGenerator	imageUrlGenerator
Microsoft.Extensions.Options.IOptions<SecuritySettings>	securitySettings
IEmailSender	emailSender
IBackOfficeSecurityAccessor	backofficeSecurityAccessor
AppCaches	appCaches
IShortStringHelper	shortStringHelper
IUserService	userService
ILocalizedTextService	localizedTextService
IUmbracoMapper	umbracoMapper
Microsoft.Extensions.Options.IOptions<GlobalSettings>	globalSettings
IBackOfficeUserManager	backOfficeUserManager
Microsoft.Extensions.Logging.ILoggerFactory	loggerFactory
Microsoft.AspNetCore.Routing.LinkGenerator	linkGenerator
IBackOfficeExternalLoginProviders	externalLogins
UserEditorAuthorizationHelper	userEditorAuthorizationHelper
IPasswordChanger<BackOfficeIdentityUser>	passwordChanger

UsersController(MediaFileManager, IOptions<ContentSettings>, IHostingEnvironment, ISqlContext, IImageUrlGenerator, IOptions<SecuritySettings>, IEmailSender, IBackOfficeSecurityAccessor, AppCaches, IShortStringHelper, IUserService, ILocalizedTextService, IUmbracoMapper, IOptions<GlobalSettings>, IBackOfficeUserManager, ILoggerFactory, LinkGenerator, IBackOfficeExternalLoginProviders, UserEditorAuthorizationHelper, IPasswordChanger<BackOfficeIdentityUser>, IHttpContextAccessor, IOptions<WebRoutingSettings>)

Declaration

[ActivatorUtilitiesConstructor]
public UsersController(MediaFileManager mediaFileManager, IOptions<ContentSettings> contentSettings, IHostingEnvironment hostingEnvironment, ISqlContext sqlContext, IImageUrlGenerator imageUrlGenerator, IOptions<SecuritySettings> securitySettings, IEmailSender emailSender, IBackOfficeSecurityAccessor backofficeSecurityAccessor, AppCaches appCaches, IShortStringHelper shortStringHelper, IUserService userService, ILocalizedTextService localizedTextService, IUmbracoMapper umbracoMapper, IOptions<GlobalSettings> globalSettings, IBackOfficeUserManager backOfficeUserManager, ILoggerFactory loggerFactory, LinkGenerator linkGenerator, IBackOfficeExternalLoginProviders externalLogins, UserEditorAuthorizationHelper userEditorAuthorizationHelper, IPasswordChanger<BackOfficeIdentityUser> passwordChanger, IHttpContextAccessor httpContextAccessor, IOptions<WebRoutingSettings> webRoutingSettings)

Parameters

Type	Name	Description
MediaFileManager	mediaFileManager
Microsoft.Extensions.Options.IOptions<ContentSettings>	contentSettings
IHostingEnvironment	hostingEnvironment
ISqlContext	sqlContext
IImageUrlGenerator	imageUrlGenerator
Microsoft.Extensions.Options.IOptions<SecuritySettings>	securitySettings
IEmailSender	emailSender
IBackOfficeSecurityAccessor	backofficeSecurityAccessor
AppCaches	appCaches
IShortStringHelper	shortStringHelper
IUserService	userService
ILocalizedTextService	localizedTextService
IUmbracoMapper	umbracoMapper
Microsoft.Extensions.Options.IOptions<GlobalSettings>	globalSettings
IBackOfficeUserManager	backOfficeUserManager
Microsoft.Extensions.Logging.ILoggerFactory	loggerFactory
Microsoft.AspNetCore.Routing.LinkGenerator	linkGenerator
IBackOfficeExternalLoginProviders	externalLogins
UserEditorAuthorizationHelper	userEditorAuthorizationHelper
IPasswordChanger<BackOfficeIdentityUser>	passwordChanger
Microsoft.AspNetCore.Http.IHttpContextAccessor	httpContextAccessor
Microsoft.Extensions.Options.IOptions<WebRoutingSettings>	webRoutingSettings

Methods

GetById(Int32)

Gets a user by Id

Declaration

[Authorize(Policy = "AdminUserEditsRequireAdmin")]
public ActionResult<UserDisplay> GetById(int id)

Parameters

Type	Name	Description
System.Int32	id

Returns

Type	Description
Microsoft.AspNetCore.Mvc.ActionResult<UserDisplay>

GetByIds(Int32[])

Get users by integer ids

Declaration

[Authorize(Policy = "AdminUserEditsRequireAdmin")]
public ActionResult<IEnumerable<UserDisplay>> GetByIds([FromJsonPath] int[] ids)

Parameters

Type	Name	Description
System.Int32[]	ids

Returns

Type	Description
Microsoft.AspNetCore.Mvc.ActionResult<System.Collections.Generic.IEnumerable<UserDisplay>>

GetCurrentUserAvatarUrls()

Returns a list of the sizes of gravatar URLs for the user or null if the gravatar server cannot be reached

Declaration

public ActionResult<string[]> GetCurrentUserAvatarUrls()

Returns

Type	Description
Microsoft.AspNetCore.Mvc.ActionResult<System.String[]>

GetPagedUsers(Int32, Int32, String, Direction, String[], UserState[], String)

Returns a paged users collection

Declaration

public UsersController.PagedUserResult GetPagedUsers(int pageNumber = 1, int pageSize = 10, string orderBy = "username", Direction orderDirection = default(Direction), [FromQuery] string[] userGroups = null, [FromQuery] UserState[] userStates = null, string filter = "")

Parameters

Type	Name	Description
System.Int32	pageNumber
System.Int32	pageSize
System.String	orderBy
Direction	orderDirection
System.String[]	userGroups
UserState[]	userStates
System.String	filter

Returns

Type	Description
UsersController.PagedUserResult

PostChangePassword(ChangingPasswordModel)

Declaration

public async Task<ActionResult<ModelWithNotifications<string>>> PostChangePassword(ChangingPasswordModel changingPasswordModel)

Parameters

Type	Name	Description
ChangingPasswordModel	changingPasswordModel

Returns

Type	Description
System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.ActionResult<ModelWithNotifications<System.String>>>

PostClearAvatar(Int32)

Declaration

[AppendUserModifiedHeader("id")]
[Authorize(Policy = "AdminUserEditsRequireAdmin")]
public ActionResult<string[]> PostClearAvatar(int id)

Parameters

Type	Name	Description
System.Int32	id

Returns

Type	Description
Microsoft.AspNetCore.Mvc.ActionResult<System.String[]>

PostCreateUser(UserInvite)

Creates a new user

Declaration

public async Task<ActionResult<UserDisplay>> PostCreateUser(UserInvite userSave)

Parameters

Type	Name	Description
UserInvite	userSave

Returns

Type	Description
System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.ActionResult<UserDisplay>>

PostDeleteNonLoggedInUser(Int32)

Deletes the non-logged in user provided id

Declaration

[Authorize(Policy = "AdminUserEditsRequireAdmin")]
public IActionResult PostDeleteNonLoggedInUser(int id)

Parameters

Type	Name	Description
System.Int32	id	User Id

Returns

Type	Description
Microsoft.AspNetCore.Mvc.IActionResult

Remarks

Limited to users that haven't logged in to avoid issues with related records constrained with a foreign key on the user Id

PostDisableUsers(Int32[])

Disables the users with the given user ids

Declaration

[Authorize(Policy = "AdminUserEditsRequireAdmin")]
public IActionResult PostDisableUsers([FromQuery] int[] userIds)

Parameters

Type	Name	Description
System.Int32[]	userIds

Returns

Type	Description
Microsoft.AspNetCore.Mvc.IActionResult

PostEnableUsers(Int32[])

Enables the users with the given user ids

Declaration

[Authorize(Policy = "AdminUserEditsRequireAdmin")]
public IActionResult PostEnableUsers([FromQuery] int[] userIds)

Parameters

Type	Name	Description
System.Int32[]	userIds

Returns

Type	Description
Microsoft.AspNetCore.Mvc.IActionResult

PostInviteUser(UserInvite)

Invites a user

Declaration

public async Task<ActionResult<UserDisplay>> PostInviteUser(UserInvite userSave)

Parameters

Type	Name	Description
UserInvite	userSave

Returns

Type	Description
System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.ActionResult<UserDisplay>>

Remarks

This will email the user an invite and generate a token that will be validated in the email

PostSaveUser(UserSave)

Saves a user

Declaration

public ActionResult<UserDisplay> PostSaveUser(UserSave userSave)

Parameters

Type	Name	Description
UserSave	userSave

Returns

Type	Description
Microsoft.AspNetCore.Mvc.ActionResult<UserDisplay>

PostSetAvatar(Int32, IList<IFormFile>)

Declaration

[AppendUserModifiedHeader("id")]
[Authorize(Policy = "AdminUserEditsRequireAdmin")]
public IActionResult PostSetAvatar(int id, IList<IFormFile> file)

Parameters

Type	Name	Description
System.Int32	id
System.Collections.Generic.IList<Microsoft.AspNetCore.Http.IFormFile>	file

Returns

Type	Description
Microsoft.AspNetCore.Mvc.IActionResult

PostSetUserGroupsOnUsers(String[], Int32[])

Declaration

[Authorize(Policy = "AdminUserEditsRequireAdmin")]
public IActionResult PostSetUserGroupsOnUsers([FromQuery] string[] userGroupAliases, [FromQuery] int[] userIds)

Parameters

Type	Name	Description
System.String[]	userGroupAliases
System.Int32[]	userIds

Returns

Type	Description
Microsoft.AspNetCore.Mvc.IActionResult

PostUnlockUsers(Int32[])

Unlocks the users with the given user ids

Declaration

[Authorize(Policy = "AdminUserEditsRequireAdmin")]
public async Task<IActionResult> PostUnlockUsers([FromQuery] int[] userIds)

Parameters

Type	Name	Description
System.Int32[]	userIds

Returns

Type	Description
System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult>