Group

3 minute readReference

addUsersToGroup

Adds one or more specified users to a 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

Assigns the specified list of groups to an existing persona.

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

Creates a new local group of users or personas.

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 local 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

Retrieves a group by its 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

Retrieves all groups.

Arguments

Argument Name Type Description

filter

String

Apply a glob-style filter (for example, 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

Specifies the order to sort the results.

Usage

import com.electriccloud.client.groovy.ElectricFlow import com.electriccloud.client.groovy.models.* ElectricFlow ef = new ElectricFlow() def result = ef.getGroups( /* optional arguments */)

getPersonaGroups

Retrieves all groups that have a 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

Modifies 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

The 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

Removes one or more 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

Unassigns the specified groups from the specified persona.

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