Group commands

addUsersToGroup

Merge a list of users into an existing local group.

Arguments

Argument Name Type Description

groupName

String

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

userNames

String array

List of users to add/remove from the group.

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.addUsersToGroup(
                groupName: 'test-groupName'
                /* optional arguments */)

assignPersonaToGroup

Assign persona to groups.

Arguments

Argument Name Type Description

personaName

String

The persona name. (Required)

groupNames

String array

List of groups that have personas.

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.assignPersonaToGroup(
                personaName: 'test-personaName'
                /* optional arguments */)

createGroup

Create a new group.

Arguments

Argument Name Type Description

groupName

String

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

personas

String array

List of personas that this group has.

userNames

String array

List of users in the group.

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.createGroup(
                groupName: 'test-groupName'
                /* optional arguments */)

deleteGroup

Deletes a group.

Arguments

Argument Name Type Description

groupName

String

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

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.deleteGroup(
                groupName: 'test-groupName')

getGroup

Retrieve a group by name.

Arguments

Argument Name Type Description

groupName

String

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

providerName

String

The name of the provider from which to get the group.

traverseHierarchy

Boolean

Set to 0 or true to include nested groups in the result if this is an LDAP group and recursive traversal of group hierarchy is enabled for the directory provider.

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.getGroup(
                groupName: 'test-groupName'
                /* optional arguments */)

getGroups

Retrieve all groups.

Arguments

Argument Name Type Description

filter

String

Apply a glob-style filter (e.g. 'foo*') when looking for users or groups.

includeAll

Boolean

Whether to include all users or groups, or only users or groups that are known to the system.

maximum

Integer

The maximum number of users or groups to return.

sortOrder

String

Which order to sort in

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.getGroups(
                /* optional arguments */)

getPersonaGroups

Retrieve all groups which have certain persona.

Arguments

Argument Name Type Description

personaName

String

The persona name. (Required)

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.getPersonaGroups(
                personaName: 'test-personaName')

modifyGroup

Modify an existing group.

Arguments

Argument Name Type Description

groupName

String

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

clearPersonas

Boolean

clear personas for group, if modifying.

migrateSettings

String

New group name to which settings will be migrated.

newName

String

New name for an existing object that is being renamed.

personas

String array

List of personas that this group has.

removeAllUsers

Boolean

True to remove all users from this group.

userNames

String array

List of users in the group.

Usage

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 */)

removeUsersFromGroup

Remove a list of users from an existing local group.

Arguments

Argument Name Type Description

groupName

String

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

userNames

String array

List of users to add/remove from the group.

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.removeUsersFromGroup(
                groupName: 'test-groupName'
                /* optional arguments */)

unassignPersonaFromGroup

remove persona from groups.

Arguments

Argument Name Type Description

personaName

String

The persona name. (Required)

groupNames

String array

List of groups that have personas.

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.unassignPersonaFromGroup(
                personaName: 'test-personaName'
                /* optional arguments */)