The UserService acts as a "gateway" to Umbraco data for operations which are related to Users.
Namespace: Umbraco.Core.Services
Assembly: Umbraco.Core.dll
All samples listed in this document will require references to the following dll:
Umbraco.Core.dll
All samples in this document will require the following using statements:
If you wish to use the UserService in a class that inherits from one of the Umbraco base classes (eg. SurfaceController
, UmbracoApiController
or UmbracoAuthorizedApiController
), you can access the service through a local Services
property:
In other cases, you may be able to use Dependency Injection. For instance if you have registered your own class in Umbraco's dependency injection, you can specify the IUserService
interface in your constructor:
If neither a Services
property or Dependency Injection is available, you can also reference the static Current
class directly:
Create a new user Quick sample showing how to create a new backoffice user; including setting a password, assigning the user to a user group, and setting the name of the user.
This will show you how to create a new user using the UserService in Umbraco.
If you want to create a new user, you'd use ASP.NET identity APIs like it is used in core.
Permissions aren't administered for the specific user, but rather for the user group(s) that the user is a part of. So to add our new user to a user group, we first need to get a reference to the user via the GetUserGroupByAlias
method, and then use the AddGroup
method for adding the group to our user:
To make sure that these changed are saved to the database, we must also make sure to call the Save
method. The GetUserGroupByAlias
method takes the alias of a user group - eg. admin
for the default Administrators user group.