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

User email

2 minute readReference

createUserEmail

Creates a new alternative user/email address mapping.

Arguments

Argument Name Type Description

userName

String

(Required) User that contains this email.

email

String

(Required) The email address.

Positional arguments

userName, email

Usage

ec-perl

$cmdr->createUserEmail(<userName>, <email>);
▼

ectool

ectool createUserEmail userName email
▼

deleteUserEmail

Deletes a new user/email address mapping.

Arguments

Argument Name Type Description

userName

String

(Required) User that contains this email.

email

String

(Required) The email address.

Positional arguments

userName, email

Usage

ec-perl

$cmdr->deleteUserEmail(<userName>, <email>);
▼

ectool

ectool deleteUserEmail userName email
▼

getUserEmail

Retrieves the specified user/email mapping.

Arguments

Argument Name Type Description

userName

String

(Required) User that contains this email.

email

String

(Required) The email address.

Positional arguments

userName, email

Usage

ec-perl

$cmdr->getUserEmail(<userName>, <email>);
▼

ectool

ectool getUserEmail userName email
▼

getUserEmails

Retrieves all user/email mappings for the specified user.

Arguments

Argument Name Type Description

userName

String

(Required) User that contains this email.

Positional arguments

userName

Usage

ec-perl

$cmdr->getUserEmails(<userName>);
▼

ectool

ectool getUserEmails userName
▼

modifyUserEmail

Modifies a user/email mapping.

Arguments

Argument Name Type Description

userName

String

(Required) User that contains this email.

email

String

(Required) The email address.

newEmail

String

The new email address.

Positional arguments

userName, email

Usage

ec-perl

$cmdr->modifyUserEmail(<userName>, <email>, {<optionals>});
▼

ectool

ectool modifyUserEmail userName email [optionals]
▼

verifyUserEmail

For use in a test or QE environment, this endpoint verifies the email address for the specified user. It simulates the logic of email verification by the user, via a signature token, without actually sending the email to the user.

In a production system, verification email is sent using:

  • Automatically to the user via the CloudBees Software Delivery Automation server when an alternative email is created or modified.

  • Using a special verify action in the CloudBees CI licenses for unverified CloudBees CI users.

Arguments

Argument Name Type Description

email

String

(Required) The email address for verification.

signature

String

Signature for verification email address.

Positional arguments

email

Usage

ec-perl

$cmdr->verifyUserEmail(<email>, {<optionals>});
▼

ectool

ectool verifyUserEmail email [optionals]
▼
User
Utility resource