Groovy API reference

Credential

7 minute readReference

addCredentialToPluginConfiguration

This command is a Preview feature.
Preview

A Preview feature:

  • Has not undergone end-to-end testing with CloudBees products

  • Is provided without service-level agreements (SLA) and therefore does not include CloudBees' commitment on functionality or performance

  • May impact other stable areas of the product when used

  • May have limited documentation

  • May not be feature complete during the Preview period

  • May graduate from preview state to fully supported or be removed from the product

  • May introduce incompatible, backward-breaking changes that could revoke the ability to upgrade

Product features and documentation are frequently updated. If you find an issue or have a suggestion, please contact CloudBees Support.

Adds a credential to a given plugin configuration.

Arguments

Argument Name Type Description

pluginConfigurationName

String

(Required) Unique name of the plugin configuration within the project.

projectName

String

(Required) The name for the project that must be unique among all projects.

credentialName

String

(Required) The name of the credential.

credentialProviderName

String

Name of the credential provider where the credential secret is stored.

credentialProviderProjectName

String

Name of the credential provider project, if different from the credential project.

credentialType

CredentialType

Credential type. Default is LOCAL.

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.

password

String

The password for the credential. Can also be a certificate or any other chunk of data.

passwordRecoveryAllowed

Boolean

If true, recovering the password by invoking getFullCredential from a job step is allowed.

pluginKey

String

The plugin key.

pluginProjectName

String

The name for the plugin’s project.

secretPath

String

Name of the folder where the password is stored.

test

Boolean

Applicable if credentialProviderName is specified. Whether to test that the credential exists in the secret management system prior to saving. Defaults to true.

userName

String

The user name for the credential.

virtualUserName

String

Applicable for cyberark ccp provider type. This property identifies two identically provisioned accounts in a dual accounts pair under one virtual username.

Positional arguments

pluginConfigurationName, projectName, credentialName

Usage

ec-perl

$cmdr->addCredentialToPluginConfiguration(<pluginConfigurationName>, <projectName>, <credentialName>, {<optionals>});

ectool

ectool addCredentialToPluginConfiguration pluginConfigurationName,  projectName,  credentialName, [optionals]

attachCredential

Attaches a credential to an object, such as a step or a schedule. Attaching a credential allows the credential to be passed as an actual argument by a schedule or subprocedure step, or to be used in a getFullCredential call by a command step.

Arguments

Argument Name Type Description

projectName

String

(Required) The name for the project that must be unique among all projects.

credentialName

String

(Required) The name of the credential.

applicationName

String

The name of the application, if attaching a credential to an application process, or application process step.

applicationProjectName

String

The name of the project containing specified application. If not specified, it is defaulted to the release project name.

catalogItemName

String

The name of the catalog item, if attaching a credential to a catalog item.

catalogName

String

The name of the catalog, if attaching a credential to a catalog.

componentName

String

The name of the component, if attaching a credential to a component, component process, or component process step.

deployerTaskName

String

The name of the deployer task mapped to the deployer configuration.

gateType

GateType

The type of the gate.

microserviceName

String

The name of the microservice, if attaching a credential to a microservice process.

pipelineName

String

The name of the pipeline, if attaching a credential to a stage task.

procedureName

String

The name of the procedure, if attaching a credential to a procedure or a procedure step.

processName

String

The name of the process, if attaching a credential to a process or a process step.

processStepName

String

The name of the process step, if attaching a credential to a process step.

releaseName

String

The name of the release, if attaching a credential to a release.

scheduleName

String

The name of the schedule, if attaching a credential to a schedule.

stageName

String

The name of the stage, if attaching a credential to its task.

stateDefinitionName

String

The name of the workflow state definition, if attaching a credential to a state definition.

stepName

String

The name of the procedure step, if attaching a credential to a procedure step.

taskName

String

The name of the task, if attaching a credential to a task.

triggerName

String

The name of the trigger, if attaching a credential to a trigger.

workflowDefinitionName

String

The name of the workflow, if attaching a credential to a state definition.

Positional arguments

projectName, credentialName

Usage

ec-perl

$cmdr->attachCredential(<projectName>, <credentialName>, {<optionals>});

ectool

ectool attachCredential projectName,  credentialName, [optionals]

createCredential

Creates a new credential for a project.

Arguments

Argument Name Type Description

projectName

String

(Required) The name for the project that must be unique among all projects.

credentialName

String

(Required) The name of the credential.

userName

String

(Required) The user name for the credential.

password

String

(Required) The password for the credential. Can also be a certificate or any other chunk of data.

credentialProviderName

String

Name of the credential provider where the credential secret is stored.

credentialProviderProjectName

String

Name of the credential provider project, if different from the credential project.

credentialType

CredentialType

Credential type. Default is LOCAL.

description

String

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

passwordRecoveryAllowed

Boolean

If true, recovering the password by invoking getFullCredential from a job step is allowed.

secretPath

String

Name of the folder where the password is stored.

test

Boolean

Applicable if credentialProviderName is specified. Whether to test that the credential exists in the secret management system prior to saving. Defaults to true.

virtualUserName

String

Applicable for cyberark ccp provider type. This property identifies two identically provisioned accounts in a dual accounts pair under one virtual username.

Positional arguments

projectName, credentialName, userName, password

Usage

ec-perl

$cmdr->createCredential(<projectName>, <credentialName>, <userName>, <password>, {<optionals>});

ectool

ectool createCredential projectName,  credentialName,  userName,  password, [optionals]

deleteCredential

Deletes a credential.

Arguments

Argument Name Type Description

projectName

String

(Required) The name for the project that must be unique among all projects.

credentialName

String

(Required) The name of the credential.

Positional arguments

projectName, credentialName

Usage

ec-perl

$cmdr->deleteCredential(<projectName>, <credentialName>);

ectool

ectool deleteCredential projectName,  credentialName

detachCredential

Detaches a credential from an object.

Depending on where the credential is attached, you must specify a step (using procedureName and stepName ), or define a schedule (using scheduleName ).

Arguments

Argument Name Type Description

projectName

String

(Required) The name for the project that must be unique among all projects.

credentialName

String

(Required) The name of the credential.

applicationName

String

The name of the application, if attaching a credential to an application process, or application process step.

applicationProjectName

String

The name of the project containing specified application. If not specified, it is defaulted to the release project name.

catalogItemName

String

The name of the catalog item, if attaching a credential to a catalog item.

catalogName

String

The name of the catalog, if attaching a credential to a catalog.

componentName

String

The name of the component, if attaching a credential to a component, component process, or component process step.

deployerTaskName

String

The name of the deployer task mapped to the deployer configuration.

gateType

GateType

The type of the gate.

microserviceName

String

The name of the microservice, if attaching a credential to a microservice process.

pipelineName

String

The name of the pipeline, if attaching a credential to a stage task.

procedureName

String

The name of the procedure, if attaching a credential to a procedure or a procedure step.

processName

String

The name of the process, if attaching a credential to a process or a process step.

processStepName

String

The name of the process step, if attaching a credential to a process step.

releaseName

String

The name of the release, if attaching a credential to a release.

scheduleName

String

The name of the schedule, if attaching a credential to a schedule.

stageName

String

The name of the stage, if attaching a credential to its task.

stateDefinitionName

String

The name of the workflow state definition, if attaching a credential to a state definition.

stepName

String

The name of the procedure step, if attaching a credential to a procedure step.

taskName

String

The name of the task, if attaching a credential to a task.

triggerName

String

The name of the trigger, if attaching a credential to a trigger.

workflowDefinitionName

String

The name of the workflow, if attaching a credential to a state definition.

Positional arguments

projectName, credentialName

Usage

ec-perl

$cmdr->detachCredential(<projectName>, <credentialName>, {<optionals>});

ectool

ectool detachCredential projectName,  credentialName, [optionals]

getCredential

Finds a credential by name.

Arguments

Argument Name Type Description

projectName

String

(Required) The name for the project that must be unique among all projects.

credentialName

String

(Required) The name of the credential.

Positional arguments

projectName, credentialName

Usage

ec-perl

$cmdr->getCredential(<projectName>, <credentialName>);

ectool

ectool getCredential projectName,  credentialName

getCredentials

Retrieves all credentials in a project.

Arguments

Argument Name Type Description

projectName

String

(Required) The name for the project that must be unique among all projects.

includeHidden

Boolean

If true, return only credentials explicitly created by a user (i.e. not autocreated like for plugin configurations)

usableOnly

Boolean

If true, return only those credentials which the current user has the execute privilege on.

Positional arguments

projectName

Usage

ec-perl

$cmdr->getCredentials(<projectName>, {<optionals>});

ectool

ectool getCredentials projectName, [optionals]

getFullCredential

Retrieves a credential by name, including a user name or password, from within a running step.

Arguments

Argument Name Type Description

credentialName

String

(Required) The name of the credential.

jobStepId

UUID

(Required) The ID of the job step to use.

Positional arguments

credentialName, jobStepId

Usage

ec-perl

$cmdr->getFullCredential(<credentialName>, <jobStepId>);

ectool

ectool getFullCredential credentialName,  jobStepId

modifyCredential

Modifies an existing credential.

Arguments

Argument Name Type Description

projectName

String

(Required) The name for the project that must be unique among all projects.

credentialName

String

(Required) The name of the credential.

credentialProviderName

String

Name of the credential provider where the credential secret is stored.

credentialProviderProjectName

String

Name of the credential provider project, if different from the credential project.

credentialType

CredentialType

Credential type. Default is LOCAL.

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.

password

String

The password for the credential. Can also be a certificate or any other chunk of data.

passwordRecoveryAllowed

Boolean

If true, recovering the password by invoking getFullCredential from a job step is allowed.

secretPath

String

Name of the folder where the password is stored.

test

Boolean

Applicable if credentialProviderName is specified. Whether to test that the credential exists in the secret management system prior to saving. Defaults to true.

userName

String

The user name for the credential.

virtualUserName

String

Applicable for cyberark ccp provider type. This property identifies two identically provisioned accounts in a dual accounts pair under one virtual username.

Positional arguments

projectName, credentialName

Usage

ec-perl

$cmdr->modifyCredential(<projectName>, <credentialName>, {<optionals>});

ectool

ectool modifyCredential projectName,  credentialName, [optionals]