createUser

Back to index

Summary

Create a new user.
This API applies to local users only.

User or group lists:

The createUser and modifyUser commands can use an optional groupNames argument. The createGroup and modifyGroup commands can have an optional userNames argument. In each case, the argument is followed by a list of groups or names. Using ectool, your command string would be:

`ectool createGroup "New Group Name" --userNames "A Adams" "B Barker"`

To make this call via the Perl API, create a list of names and then pass a reference to the list as an optional parameter. The name of the optional parameter is singular, userName or userGroup; not the plural form used by ectool. For example:

# Run the procedure—pass a reference to the list of names $xPath = $cmdr\->createGroup("New Group Name", { "userName" => ['A Adams', 'B Burns'] });
You must specify a userName.
userName
Stringrequired
The user name.
email
Stringoptional
Email address of the user.
fullUserName
Stringoptional
Full name of the user.
groupNames
Collectionoptional
List of groups that this user is in.
password
Stringoptional
The users password.
personas
Collectionoptional
List of personas that this user has.

Usage

Perl

$cmdr->createUser( "test-userName" # userName # optionals );

ectool

ectool createUser \ "test-userName" `# userName` \ # optionals

Examples

Perl

$cmdr->createUser("aallen", {fullUserName => "Albert Allen"});
$cmdr->createUser("Betty Barker");
$cmdr->createUser("Betty Barker", {personas => "Release Manager"});

ectool

ectool createUser "aallen" --fullUserName "Albert Allen"
ectool createUser "Betty Barker"
ectool createUser "Betty Barker" --personas "Release Manager"