force-user-create Task

Description

Create a user for a scratch org.

It executes the force:user:create command.

Parameters

In addition to the attributes used by every ant-sfdx task, this task uses the following attributes:

Attribute Command line equivalent Description Required
alias -a An alias for the created username. No
definitionfile -f A user definition file. No
targetusername -u A username or alias for the target org. No
targetdevhubusername -v A username or alias for the target Dev Hub org. No

Parameters specified as nested elements

param

Specifies parameters to be used for the user creation, sent as key=value pairs to the Salesforce DX CLI command. See property for usage guidelines.

Examples

<force-user-create />
<force-user-create alias="testuser1" definitionfile="config/project-user-def.json" />
<force-user-create>
    <param name="username" value="testuser1@my.org" />
    <param name="email" value="me@my.org" />
    <param name="permsets" value="DreamHouse" />
</force-user-create>
<force-user-create definitionfile="config/project-user-def.json">
    <param name="email" value="me@my.org" />
    <param name="generatepassword" value="true" />
</force-user-create>

Version: 0.0.0-master