modifyGroup

Back to index

Summary

Modifies an existing group.

groupName

Stringrequired

Name of the group; must be unique among local groups.

clearPersonas

Booleanoptional

Clear personas for group, if modifying.

migrateSettings

Stringoptional

New group name to which settings will be migrated.

newName

Stringoptional

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

personas

Array<Unknown>optional

List of personas that this group has.

removeAllUsers

Booleanoptional

True to remove all users from this group.

userNames

Array<Unknown>optional

List of users in the group.

Usage

Groovy

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

ElectricFlow ef = new ElectricFlow()

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