modifyUser

Summary

Modifies a non-local (LDAP) user that is registered with CloudBees CD/RO (with certain limitations described below) or a local user.

userName

Stringrequired

The user name.

clearPersonas

Booleanoptional

Clear personas for user, if modifying.

email

Stringoptional

Email address of the user.

fullUserName

Stringoptional

Full name of the user.

groupNames

Array<Unknown>optional

List of groups that this user is in.

migrateSettings

Stringoptional

Migrate the user or group settings to this name.

newName

Stringoptional

The new name for an existing object that is being renamed.

password

Stringoptional

The users password.

personas

Array<Unknown>optional

List of personas that this user has.

removeFromAllGroups

Booleanoptional

True to remove this user from all groups.

sessionPassword

Stringoptional

Session user's password. Used to re-verify identity before changing user passwords in the system.

Usage

Groovy

import com.electriccloud.client.groovy.ElectricFlow
import com.electriccloud.client.groovy.models.*

ElectricFlow ef = new ElectricFlow()

def result = ef.modifyUser(
  userName: "test-userName"
  /* optional arguments */
)▼