Introduction
IntroductionAccess tokenACLApplication dependencyApplicationApplication tierArchive connectorArtifactCatalogCatalog item runChange 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
IntroductionaccesstokenaclaclentryactualparameterapplicationapplicationdependencyapplicationtierarchiveconnectorartifactartifactversioncatalogcatalogitemcatalogitemruncibuildcibuilddetailciconfigurationcieventclustercomponentcredentialcredentialproviderdashboarddashboardcolumndataretentionpolicydeployerapplicationdeployerconfigurationdeploymenthistoryitemdevopsinsightdatasourcedirectoryprovideremailconfigemailnotifierentitychangeenvironmentenvironmentinventoryitemenvironmenttemplateenvironmenttemplatetierenvironmenttemplatetiermapenvironmenttemplatetiermappingenvironmenttierenvtempltierresourcetemplmappingeventsubscriptionflowruntimeformaloutputparameterformalparametergategatewaygrouphookjobjobstepkerberoskeytablicensemicroservicemicroservicemappingnoteobjectopenidconnectconfigurationoutputparameterpersonapersonacategorypersonapagepipelinepluginplugincatalogpluginconfigurationprocedureprocedurestepprocessprocessdependencyprocessstepprojectpropertyreleasereportreportingfilterreportobjectassociationreportobjectattributereportobjecttyperepositoryreservationresourceresourcepoolresourcetemplateresourceusageretrievedartifactsrollingdeployphaserundiscoverysamlidentityprovidersamlserviceproviderschedulescmsyncsearchfilterserverserversettingserversettingcategoryserviceaccountsessionsnapshotstagestatestatedefinitionstringresulttagtasktiermaptiermappingtransitiontransitiondefinitiontriggertriggererrordetailuseraccesstokenuseruseremailutilityresourcewaitdependencywebhookresultwidgetwidgetfilteroverrideworkflowworkflowdefinitionworkitemworkspacezoneArgument models

Persona

4 minute readReference

addPageToPersonaCategory

Adds a persona page to a given category.

Arguments

Argument Name Type Description

personaCategoryName

String

(Required) The persona category name.

personaPageName

String

(Required) The persona page name.

afterPage

String

If specified, the page will be placed after the named page.

beforePage

String

If specified, the page will be placed before the named page.

Positional arguments

personaCategoryName, personaPageName

Usage

ec-perl

$cmdr->addPageToPersonaCategory(<personaCategoryName>, <personaPageName>, {<optionals>});
▼

ectool

ectool addPageToPersonaCategory personaCategoryName,  personaPageName, [optionals]
▼

addPersonaDetail

Creates a new personaDetail object.

Arguments

Argument Name Type Description

personaName

String

(Required) The persona name.

personaCategoryName

String

(Required) The persona category name.

personaPages

Collection

A list of pages in a persona category.

Positional arguments

personaName, personaCategoryName

Usage

ec-perl

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

ectool

ectool addPersonaDetail personaName,  personaCategoryName, [optionals]
▼

addPersonaSubpage

Adds one or more persona subpage to a given page.

Arguments

Argument Name Type Description

personaPageName

String

(Required) The persona page name.

personaPages

Collection

A list of subpages.

Positional arguments

personaPageName

Usage

ec-perl

$cmdr->addPersonaSubpage(<personaPageName>, {<optionals>});
▼

ectool

ectool addPersonaSubpage personaPageName, [optionals]
▼

assignPersonaToUser

Assigns a list of valid users to an existing persona.

Arguments

Argument Name Type Description

personaName

String

(Required) The persona name.

userNames

Collection

List of users that have personas.

Positional arguments

personaName

Usage

ec-perl

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

ectool

ectool assignPersonaToUser personaName, [optionals]
▼

createPersona

Creates a new persona object.

Arguments

Argument Name Type Description

personaName

String

(Required) The persona name.

description

String

Comment text describing this object that is not interpreted at all by CloudBees CD/RO.

homePageName

String

The default home page.

isDefault

Boolean

Set as default persona.

personaDetails

String

The details of the persona, if creating.

Positional arguments

personaName

Usage

ec-perl

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

ectool

ectool createPersona personaName, [optionals]
▼

createPersonaCategory

Creates a new personaCategory object. Specify the name of the new page with personaCategoryName.

Arguments

Argument Name Type Description

personaCategoryName

String

(Required) The persona category name.

afterCategory

String

If specified, the category will be placed after the named category.

beforeCategory

String

If specified, the category will be placed before the named category.

description

String

Comment text describing this object that is not interpreted at all by CloudBees CD/RO.

enabled

Boolean

Whether to enable the PersonaCategory.

personaPages

Collection

A list of pages in a persona category.

Positional arguments

personaCategoryName

Usage

ec-perl

$cmdr->createPersonaCategory(<personaCategoryName>, {<optionals>});
▼

ectool

ectool createPersonaCategory personaCategoryName, [optionals]
▼

createPersonaPage

Creates a new personaPage object.

Specify the name of the new page with personaPageName.

Arguments

Argument Name Type Description

personaPageName

String

(Required) The persona page name.

description

String

Comment text describing this object that is not interpreted at all by CloudBees CD/RO.

subpages

Collection

A list of subpages.

url

String

The persona page url.

Positional arguments

personaPageName

Usage

ec-perl

$cmdr->createPersonaPage(<personaPageName>, {<optionals>});
▼

ectool

ectool createPersonaPage personaPageName, [optionals]
▼

deletePersona

Deletes the specified persona.

Arguments

Argument Name Type Description

personaName

String

(Required) The persona name.

Positional arguments

personaName

Usage

ec-perl

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

ectool

ectool deletePersona personaName
▼

deletePersonaCategory

Deletes the specified personaCategory object by name.

Arguments

Argument Name Type Description

personaCategoryName

String

(Required) The persona category name.

Positional arguments

personaCategoryName

Usage

ec-perl

$cmdr->deletePersonaCategory(<personaCategoryName>);
▼

ectool

ectool deletePersonaCategory personaCategoryName
▼

deletePersonaPage

Deletes the specified personaPage object.

Arguments

Argument Name Type Description

personaPageName

String

(Required) The persona page name.

force

Boolean

If true persona page is force removed.

Positional arguments

personaPageName

Usage

ec-perl

$cmdr->deletePersonaPage(<personaPageName>, {<optionals>});
▼

ectool

ectool deletePersonaPage personaPageName, [optionals]
▼

getPersona

Retrieves the specified persona.

Arguments

Argument Name Type Description

personaName

String

(Required) The persona name.

Positional arguments

personaName

Usage

ec-perl

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

ectool

ectool getPersona personaName
▼

getPersonaCategories

Retrieves all persona categories.

Arguments

Argument Name Type Description

includeDisabled

Boolean

Whether to include disabled PersonaCategories.

Positional arguments

None.

Usage

ec-perl

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

ectool

ectool getPersonaCategories [optionals]
▼

getPersonaCategory

Retrieves the specified personaCategory object.

Arguments

Argument Name Type Description

personaCategoryName

String

(Required) The persona category name.

Positional arguments

personaCategoryName

Usage

ec-perl

$cmdr->getPersonaCategory(<personaCategoryName>);
▼

ectool

ectool getPersonaCategory personaCategoryName
▼

getPersonaPage

Retrieves the specified personaPage object.

Arguments

Argument Name Type Description

personaPageName

String

(Required) The persona page name.

Positional arguments

personaPageName

Usage

ec-perl

$cmdr->getPersonaPage(<personaPageName>);
▼

ectool

ectool getPersonaPage personaPageName
▼

getPersonaPages

Retrieves all persona pages.

Arguments

None.

Positional arguments

None.

Usage

ec-perl

$cmdr->getPersonaPages();
▼

ectool

ectool getPersonaPages
▼

getPersonas

Retrieves persona objects subject to specified criteria sent with the request. If no arguments are specified, all personas in the system are returned, sorted by persona name.

Arguments

Argument Name Type Description

excludeGroupPersonas

Boolean

If true, exclude personas set for groups when specify userName.

groupName

String

The group name.

includeDetails

Boolean

True to include details (default is false).

merged

Boolean

If true, merge the persona details when specify userName.

userName

String

The user name.

Positional arguments

None.

Usage

ec-perl

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

ectool

ectool getPersonas [optionals]
▼

getPersonaUsers

Retrieves all users that have a certain persona.

Arguments

Argument Name Type Description

personaName

String

(Required) The persona name.

includeProvider

Boolean

Whether to include disabled PersonaCategories.

Positional arguments

personaName

Usage

ec-perl

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

ectool

ectool getPersonaUsers personaName, [optionals]
▼

modifyPersona

Modifies the specified persona object.

Arguments

Argument Name Type Description

personaName

String

(Required) The persona name.

clearDetails

Boolean

Clears persona details, if modifying.

description

String

Comment text describing this object that is not interpreted at all by CloudBees CD/RO.

homePageName

String

The default home page.

isDefault

Boolean

Set as default persona.

newName

String

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

personaDetails

String

The details of the persona, if creating.

Positional arguments

personaName

Usage

ec-perl

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

ectool

ectool modifyPersona personaName, [optionals]
▼

modifyPersonaCategory

Modifies the specified personaCategory object.

Arguments

Argument Name Type Description

personaCategoryName

String

(Required) The persona category name.

afterCategory

String

If specified, the category will be placed after the named category.

beforeCategory

String

If specified, the category will be placed before the named category.

clearPages

Boolean

Clears persona pages for the category, if modifying.

description

String

Comment text describing this object that is not interpreted at all by CloudBees CD/RO.

enabled

Boolean

Whether to enable the PersonaCategory.

newName

String

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

personaPages

Collection

A list of pages in a persona category.

Positional arguments

personaCategoryName

Usage

ec-perl

$cmdr->modifyPersonaCategory(<personaCategoryName>, {<optionals>});
▼

ectool

ectool modifyPersonaCategory personaCategoryName, [optionals]
▼

modifyPersonaPage

Modifies the specified personaPage object.

Arguments

Argument Name Type Description

personaPageName

String

(Required) The persona page name.

description

String

Comment text describing this object that is not interpreted at all by CloudBees CD/RO.

newName

String

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

subpages

Collection

A list of subpages.

url

String

The persona page url.

Positional arguments

personaPageName

Usage

ec-perl

$cmdr->modifyPersonaPage(<personaPageName>, {<optionals>});
▼

ectool

ectool modifyPersonaPage personaPageName, [optionals]
▼

removePersonaDetail

Removes a personaDetail object.

Arguments

Argument Name Type Description

personaName

String

(Required) The persona name.

personaCategoryName

String

(Required) The persona category name.

personaPages

Collection

A list of pages in a persona category.

Positional arguments

personaName, personaCategoryName

Usage

ec-perl

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

ectool

ectool removePersonaDetail personaName,  personaCategoryName, [optionals]
▼

removePersonaSubpage

Deletes a persona subpage.

Arguments

Argument Name Type Description

personaPageName

String

(Required) The persona page name.

personaPages

Collection

A list of subpages.

Positional arguments

personaPageName

Usage

ec-perl

$cmdr->removePersonaSubpage(<personaPageName>, {<optionals>});
▼

ectool

ectool removePersonaSubpage personaPageName, [optionals]
▼

unassignPersonaFromUser

Unassigns the specified list of users from the existing persona.

Arguments

Argument Name Type Description

personaName

String

(Required) The persona name.

userNames

Collection

List of users that have personas.

Positional arguments

personaName

Usage

ec-perl

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

ectool

ectool unassignPersonaFromUser personaName, [optionals]
▼
Parameter
Pipeline