API error messages
Introduction
IntroductionAccess tokenACLApplication dependencyApplicationApplication tierArchive connectorArtifactCatalogChange historyCI buildCI build detailCI configurationCI eventCI jobClusterComponentsCredentialCredential providerCustom filterDashboardDashboard columnDatabase configurationData retention policyDeployer applicationDevOps Insight data sourceDirectory providerDynamic environmentEmail configurationEmail notifierEnvironmentEnvironment tierGatewayGroupInstalling or upgrading remote agentsJobKerberos keytabMicroserviceMicroservice mappingMiscellaneousObjectObject tagsParameterPersonaPipelinePluginPlugin configurationPlugin catalogProcedureProcessProcess dependencyProcess stepProjectPropertyReleaseReportReporting filterReport object associationReport object attributeReport object typeResourceRolling deployScheduleSCM syncServerServer settings categoryService accounts for webhooksSessionSingle sign-on for OpenID ConnectSingle sign-on for SAMLSnapshotsTier mapTriggerUserUser emailUtility resourceWait dependencyWebhook resultWidgetWidget filter overrideWorkflowWorkflow definitionWork itemsWorkspaceZone
Perl API response and element glossary
Introduction
Examples
Troubleshooting
IntroductionaccesstokenaclaclentryactualparameterapplicationapplicationdependencyapplicationtierarchiveconnectorartifactartifactversioncatalogcatalogitemcibuildcibuilddetailciconfigurationcieventclustercomponentcredentialcredentialproviderdashboarddashboardcolumndataretentionpolicydeployerapplicationdeployerconfigurationdeploymenthistoryitemdevopsinsightdatasourcedirectoryprovideremailconfigemailnotifierentitychangeenvironmentenvironmentinventoryitemenvironmenttemplateenvironmenttemplatetierenvironmenttemplatetiermapenvironmenttemplatetiermappingenvironmenttierenvtempltierresourcetemplmappingeventsubscriptionflowruntimeformaloutputparameterformalparametergategatewaygrouphookjobjobstepkerberoskeytablicensemicroservicemicroservicemappingnoteobjectopenidconnectconfigurationoutputparameterpersonapersonacategorypersonapagepipelinepluginplugincatalogpluginconfigurationprocedureprocedurestepprocessprocessdependencyprocessstepprojectpropertyreleasereportreportingfilterreportobjectassociationreportobjectattributereportobjecttyperepositoryreservationresourceresourcepoolresourcetemplateresourceusageretrievedartifactsrollingdeployphaserundiscoverysamlidentityprovidersamlserviceproviderschedulescmsyncsearchfilterserverserversettingserversettingcategoryserviceaccountsessionsnapshotstagestatestatedefinitionstringresulttagtasktiermaptiermappingtransitiontransitiondefinitiontriggertriggererrordetailuseraccesstokenuseruseremailutilityresourcewaitdependencywebhookresultwidgetwidgetfilteroverrideworkflowworkflowdefinitionworkitemworkspacezoneArgument models

Group

2 minute readReference

addUsersToGroup

Adds one or more specified users to a local group.

Arguments

Argument Name Type Description

groupName

String

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

userNames

Collection

List of users to add/remove from the group.

Positional arguments

groupName

Usage

ec-perl

$cmdr->addUsersToGroup(<groupName>, {<optionals>});
▼

ectool

ectool addUsersToGroup groupName [optionals]
▼

assignPersonaToGroup

Assigns the specified list of groups to an existing persona.

Arguments

Argument Name Type Description

personaName

String

(Required) The persona name.

groupNames

Collection

List of groups that have personas.

Positional arguments

personaName

Usage

ec-perl

$cmdr->assignPersonaToGroup(<personaName>, {<optionals>});
▼

ectool

ectool assignPersonaToGroup personaName [optionals]
▼

createGroup

Creates a new local group of users or personas.

Arguments

Argument Name Type Description

groupName

String

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

personas

Collection

List of personas that this group has.

userNames

Collection

List of users in the group.

Positional arguments

groupName

Usage

ec-perl

$cmdr->createGroup(<groupName>, {<optionals>});
▼

ectool

ectool createGroup groupName [optionals]
▼

deleteGroup

Deletes a local group.

Arguments

Argument Name Type Description

groupName

String

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

Positional arguments

groupName

Usage

ec-perl

$cmdr->deleteGroup(<groupName>);
▼

ectool

ectool deleteGroup groupName
▼

getGroup

Retrieves a group by its name.

Arguments

Argument Name Type Description

groupName

String

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

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.

Positional arguments

groupName

Usage

ec-perl

$cmdr->getGroup(<groupName>, {<optionals>});
▼

ectool

ectool getGroup groupName [optionals]
▼

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

SortOrder

Specifies the order to sort the results.

Positional arguments

None.

Usage

ec-perl

$cmdr->getGroups({<optionals>});
▼

ectool

ectool getGroups [optionals]
▼

getPersonaGroups

Retrieves all groups that have a certain persona.

Arguments

Argument Name Type Description

personaName

String

(Required) The persona name.

Positional arguments

personaName

Usage

ec-perl

$cmdr->getPersonaGroups(<personaName>);
▼

ectool

ectool getPersonaGroups personaName
▼

modifyGroup

Modifies an existing group.

Arguments

Argument Name Type Description

groupName

String

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

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

Collection

List of personas that this group has.

removeAllUsers

Boolean

True to remove all users from this group.

userNames

Collection

List of users in the group.

Positional arguments

groupName

Usage

ec-perl

$cmdr->modifyGroup(<groupName>, {<optionals>});
▼

ectool

ectool modifyGroup groupName [optionals]
▼

removeUsersFromGroup

Removes one or more users from an existing local group.

Arguments

Argument Name Type Description

groupName

String

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

userNames

Collection

List of users to add/remove from the group.

Positional arguments

groupName

Usage

ec-perl

$cmdr->removeUsersFromGroup(<groupName>, {<optionals>});
▼

ectool

ectool removeUsersFromGroup groupName [optionals]
▼

unassignPersonaFromGroup

Unassigns the specified groups from the specified persona.

Arguments

Argument Name Type Description

personaName

String

(Required) The persona name.

groupNames

Collection

List of groups that have personas.

Positional arguments

personaName

Usage

ec-perl

$cmdr->unassignPersonaFromGroup(<personaName>, {<optionals>});
▼

ectool

ectool unassignPersonaFromGroup personaName [optionals]
▼
Gateway
Installing or upgrading remote agents