addCredentialToPluginConfiguration

Back to index

Summary

Adds a credential to a given plugin configuration.

projectName

Stringrequired

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

pluginConfigurationName

Stringrequired

Unique name of the plugin configuration within the project.

credentialName

Stringrequired

The name of the credential.

credentialProviderName

Stringoptional

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

credentialProviderProjectName

Stringoptional

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

credentialType

Stringoptional

Credential type. Default is LOCAL.

Possible values: "EXTERNAL", "LOCAL"

description

Stringoptional

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

newName

Stringoptional

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

password

Stringoptional

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

passwordRecoveryAllowed

Booleanoptional

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

pluginKey

Stringoptional

The plugin key.

pluginProjectName

Stringoptional

The name for the plugin's project.

secretPath

Stringoptional

Name of the folder where the password is stored.

test

Booleanoptional

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

userName

Stringoptional

The user name for the credential.

virtualUserName

Stringoptional

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

Usage

Groovy

import com.electriccloud.client.groovy.ElectricFlow
import com.electriccloud.client.groovy.models.*

ElectricFlow ef = new ElectricFlow()

def result = ef.addCredentialToPluginConfiguration(
  projectName: "test-projectName",
  pluginConfigurationName: "test-pluginConfigurationName",
  credentialName: "test-credentialName"
  /* optional arguments */
)▼