WiX Toolset

User Element (Util Extension)

Description
User for all kinds of things. When it is not nested under a component it is included in the MSI so it can be referenced by other elements such as the User attribute in the AppPool element. When it is nested under a Component element, the User will be created on install and can also be used for reference.
Windows Installer references
None
Parents
Component, Fragment, Module, Product
Inner Text
None
Children
Sequence (min: 1, max: 1)
  1. GroupRef (min: 0, max: unbounded)
Attributes
Name Type Description Required
Id String   Yes
CanNotChangePassword YesNoType The user cannot change the account's password. Equivalent to UF_PASSWD_CANT_CHANGE.  
CreateUser YesNoType Indicates whether or not to create the user. User creation can be skipped if all that is desired is to join a user to groups.  
Disabled YesNoType The account is disabled. Equivalent to UF_ACCOUNTDISABLE.  
Domain String A Formatted string that contains the local machine or Active Directory domain for the user.  
FailIfExists YesNoType Indicates if the install should fail if the user already exists.  
LogonAsBatchJob YesNoType Indicates whether or not the user can logon as a batch job. User creation can be skipped if all that is desired is to set this access right on the user.  
LogonAsService YesNoType Indicates whether or not the user can logon as a serivce. User creation can be skipped if all that is desired is to set this access right on the user.  
Name String A Formatted string that contains the name of the user account. Yes
Password String Usually a Property that is passed in on the command-line to keep it more secure.  
PasswordExpired YesNoType Indicates whether the user must change their password on their first login.  
PasswordNeverExpires YesNoType The account's password never expires. Equivalent to UF_DONT_EXPIRE_PASSWD.  
RemoveOnUninstall YesNoType Indicates whether the user account should be removed or left behind on uninstall.  
UpdateIfExists YesNoType Indicates if the user account properties should be updated if the user already exists.  
Vital YesNoType Indicates whether failure to create the user or add the user to a group fails the installation. The default value is "yes".  
See Also
Util Schema, Group, GroupRef