Users
List of examples:
Dependency injection
Initialize required services
C#
// Initializes all services and provider classes used within
// the API examples on this page using dependency injection.
private readonly IUserInfoProvider userInfoProvider;
public UsersServices(IUserInfoProvider userInfoProvider)
{
this.userInfoProvider = userInfoProvider;
}
Users
Create new users with administration access
C#
// Creates a new user object
UserInfo newUser = new UserInfo();
// Sets the user properties
newUser.UserName = "NewUser";
newUser.Email = "new.user@domain.com";
// Enables the user
newUser.UserEnabled = true;
// Allows the user to access the administration interface
newUser.UserAdministrationAccess = true;
// Saves the user to the database
userInfoProvider.Set(newUser);
Update existing users
C#
// Gets the user
UserInfo updateUser = userInfoProvider.Get("NewUser");
if (updateUser != null)
{
// Updates the user's properties
updateUser.FirstName = updateUser.FirstName.ToLowerInvariant();
updateUser.LastName = updateUser.LastName.ToLowerInvariant();
// Saves the changes to the database
userInfoProvider.Set(updateUser);
}
Update multiple users
C#
// Gets all users whose username starts with 'NewUser'
var users = userInfoProvider.Get().WhereStartsWith("UserName", "NewUser");
// Loops through individual users
foreach (UserInfo modifyUser in users)
{
// Updates the user properties
modifyUser.FirstName = modifyUser.FirstName.ToUpper();
modifyUser.LastName = modifyUser.LastName.ToUpper();
// Saves the changes to the database
userInfoProvider.Set(modifyUser);
}
Work with custom user fields
C#
// Gets the user
UserInfo user = userInfoProvider.Get("NewUser");
if (user != null)
{
// Attempts to retrieve a value from a custom text field named 'CustomField'
string value = user.GetValue("CustomField", "");
// Sets a modified value for the custom field
user.SetValue("CustomField", value + "_customSuffix");
// Saves the changes to the database
userInfoProvider.Set(user);
}
Delete users
C#
// Gets the user
UserInfo deleteUser = userInfoProvider.Get("NewUser");
if (deleteUser != null)
{
// Deletes the user
userInfoProvider.Delete(deleteUser);
}
User authentication and authorization
Check user administration access
C#
// Gets the user
UserInfo user = userInfoProvider.Get("NewUser");
if (user != null)
{
// Checks if the user has access to the admin UI
if (user.HasAdministrationAccess())
{
// Perform an action
}
}