Back to index
Summary
Modifies a non-local (LDAP) user that is registered with CloudBees CD/RO (with certain limitations described below) or a local user.userNameStringrequiredThe user name. clearPersonasBooleanoptionalClear personas for user, if modifying. Email address of the user. fullUserNameStringoptionalFull name of the user. groupNamesStringoptionalList of groups that this user is in. migrateSettingsStringoptionalMigrate the user or group settings to this name. newNameStringoptionalThe new name for an existing object that is being renamed. passwordStringoptionalThe users password. personasStringoptionalList of personas that this user has. removeFromAllGroupsBooleanoptionalTrue to remove this user from all groups. sessionPasswordStringoptionalSession user's password. Used to re-verify identity before changing user passwords in the system. |
Usage
Perl
$cmdr->modifyUser( "test-userName" # userName # optionals );
ectool
ectool modifyUser \ "test-userName" `# userName` \ # optionals