View Source

Class UsersController

Inheritance

System.Object

UmbracoApiControllerBase

UmbracoApiController

UmbracoAuthorizedApiController

UmbracoAuthorizedJsonController

Namespace: Umbraco.Web.Editors

Assembly: Umbraco.Web.dll

Syntax

[PluginController("UmbracoApi")]
public class UsersController : UmbracoAuthorizedJsonController, IDiscoverable

Constructors

UsersController(IGlobalSettings, IUmbracoContextAccessor, ISqlContext, ServiceContext, AppCaches, IProfilingLogger, IRuntimeState, UmbracoHelper, IUmbracoSettingsSection)

Declaration

public UsersController(IGlobalSettings globalSettings, IUmbracoContextAccessor umbracoContextAccessor, ISqlContext sqlContext, ServiceContext services, AppCaches appCaches, IProfilingLogger logger, IRuntimeState runtimeState, UmbracoHelper umbracoHelper, IUmbracoSettingsSection umbracoSettingsSection)

Parameters

Type	Name	Description
IGlobalSettings	globalSettings
IUmbracoContextAccessor	umbracoContextAccessor
ISqlContext	sqlContext
ServiceContext	services
AppCaches	appCaches
IProfilingLogger	logger
IRuntimeState	runtimeState
UmbracoHelper	umbracoHelper
IUmbracoSettingsSection	umbracoSettingsSection

Methods

GetById(Int32)

Gets a user by Id

Declaration

public UserDisplay GetById(int id)

Parameters

Type	Name	Description
System.Int32	id

Returns

Type	Description
UserDisplay

GetByIds(Int32[])

Get users by integer ids

Declaration

public IEnumerable<UserDisplay> GetByIds(int[] ids)

Parameters

Type	Name	Description
System.Int32[]	ids

Returns

Type	Description
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 string[] GetCurrentUserAvatarUrls()

Returns

Type	Description
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 = Direction.Ascending, string[] userGroups = null, 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<ModelWithNotifications<string>> PostChangePassword(ChangingPasswordModel changingPasswordModel)

Parameters

Type	Name	Description
ChangingPasswordModel	changingPasswordModel

Returns

Type	Description
System.Threading.Tasks.Task<ModelWithNotifications<System.String>>

PostClearAvatar(Int32)

Declaration

public HttpResponseMessage PostClearAvatar(int id)

Parameters

Type	Name	Description
System.Int32	id

Returns

Type	Description
HttpResponseMessage

PostCreateUser(UserInvite)

Creates a new user

Declaration

public async Task<UserDisplay> PostCreateUser(UserInvite userSave)

Parameters

Type	Name	Description
UserInvite	userSave

Returns

Type	Description
System.Threading.Tasks.Task<UserDisplay>

PostDeleteNonLoggedInUser(Int32)

Deletes the non-logged in user provided id

Declaration

public HttpResponseMessage PostDeleteNonLoggedInUser(int id)

Parameters

Type	Name	Description
System.Int32	id	User Id

Returns

Type	Description
HttpResponseMessage

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

public HttpResponseMessage PostDisableUsers(int[] userIds)

Parameters

Type	Name	Description
System.Int32[]	userIds

Returns

Type	Description
HttpResponseMessage

PostEnableUsers(Int32[])

Enables the users with the given user ids

Declaration

public HttpResponseMessage PostEnableUsers(int[] userIds)

Parameters

Type	Name	Description
System.Int32[]	userIds

Returns

Type	Description
HttpResponseMessage

PostInviteUser(UserInvite)

Invites a user

Declaration

public async Task<UserDisplay> PostInviteUser(UserInvite userSave)

Parameters

Type	Name	Description
UserInvite	userSave

Returns

Type	Description
System.Threading.Tasks.Task<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 UserDisplay PostSaveUser(UserSave userSave)

Parameters

Type	Name	Description
UserSave	userSave

Returns

Type	Description
UserDisplay

PostSetAvatar(Int32)

Declaration

public async Task<HttpResponseMessage> PostSetAvatar(int id)

Parameters

Type	Name	Description
System.Int32	id

Returns

Type	Description
System.Threading.Tasks.Task<HttpResponseMessage>

PostSetUserGroupsOnUsers(String[], Int32[])

Declaration

public HttpResponseMessage PostSetUserGroupsOnUsers(string[] userGroupAliases, int[] userIds)

Parameters

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

Returns

Type	Description
HttpResponseMessage

PostUnlockUsers(Int32[])

Unlocks the users with the given user ids

Declaration

public async Task<HttpResponseMessage> PostUnlockUsers(int[] userIds)

Parameters

Type	Name	Description
System.Int32[]	userIds

Returns

Type	Description
System.Threading.Tasks.Task<HttpResponseMessage>