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
IntroductionaccesstokenaclaclentryactualparameterapplicationapplicationdependencyapplicationtierarchiveconnectorartifactartifactversioncatalogcatalogitemcibuildcibuilddetailciconfigurationcieventclustercompliancecomponentcredentialcredentialproviderdashboarddashboardcolumndataretentionpolicydeployerapplicationdeployerconfigurationdeploymenthistoryitemdevopsinsightdatasourcedirectoryprovideremailconfigemailnotifierentitychangeenvironmentenvironmentinventoryitemenvironmenttemplateenvironmenttemplatetierenvironmenttemplatetiermapenvironmenttemplatetiermappingenvironmenttierenvtempltierresourcetemplmappingeventsubscriptionflowruntimeformaloutputparameterformalparametergategatewaygrouphookjobjobstepkerberoskeytablicensemicroservicemicroservicemappingnoteobjectopenidconnectconfigurationoutputparameterpersonapersonacategorypersonapagepipelinepluginplugincatalogpluginconfigurationprocedureprocedurestepprocessprocessdependencyprocessstepprojectpropertyreleasereportreportingfilterreportobjectassociationreportobjectattributereportobjecttyperepositoryreservationresourceresourcepoolresourcetemplateresourceusageretrievedartifactsrollingdeployphaserundiscoverysamlidentityprovidersamlserviceproviderschedulescmsyncsearchfilterserverserversettingserversettingcategoryserviceaccountsessionsnapshotstagestatestatedefinitionstringresulttagtasktiermaptiermappingtransitiontransitiondefinitiontriggertriggererrordetailuseraccesstokenuseruseremailutilityresourcewaitdependencywebhookresultwidgetwidgetfilteroverrideworkflowworkflowdefinitionworkitemworkspacezoneArgument models

CredentialProvider

4 minute readReference

createCredentialProvider

Creates a new external credential provider definition for a project.

Arguments

Argument Name Type Description

projectName

String

Name of the project that the credential provider belongs to.(Required)

credentialProviderName

String

Unique name of the credential provider within the project.(Required)

accountName

String

Applicable for cyberark provider type. Name of the account where the passwords will be retrieved from.

applicationId

String

Applicable for cyberark provider type. Unique application ID that is defined in the vault.

authMethodsMapping

String

Applicable for hashicorp provider type. Mapping in JSON format for authentication methods (for example, {"approle":"some_approle_mapping", "userpass":"some_userpass_mapping"}).

cyberarkProvider

String

Applicable for cyberark provider type. The CyberArk credential provider type or the access provider to use.

cyberarkSafe

String

Applicable for cyberark provider type. Name of the safe where the passwords will be retrieved from.

description

String

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

keyPassword

String

Applicable for cyberark provider type. Password for the key.

namespace

String

Applicable for hashicorp provider type. The namespace within the Vault Enterprise instance to use.

password

String

Applicable for cyberark and hashicorp provider types. Password for the connection to the server.

providerType

String

Credential provider type.

reason

String

Applicable for cyberark provider type. Reason for credential request.

roleId

String

Applicable for hashicorp provider type. RoleID of the role used by the AppRole authentication mechanism within Vault.

secretEnginePath

String

Applicable for hashicorp provider type. Path at which the specified secret engine is enabled.

secretEngineType

String

Applicable for hashicorp provider type. Name of the secret engine.

secretId

String

Applicable for hashicorp provider type. SecretID used by the AppRole authentication mechanism.

serverUrl

String

Applicable for cyberark and hashicorp provider types. URL for connecting to the credential provider.

store

String

Applicable for cyberark provider type. PKCS 12 storage with certificates and keys for connection to the server.

storePassword

String

Applicable for cyberark provider type. Password for the store.

testConnection

Boolean

Specifies if the connection to the CI server should be tested before saving the configuration. The default is false.

testSecret

String

Applicable for cyberark CCP provider type. Test secret to test the connection for a CCP credential provider type.

token

String

Applicable for hashicorp provider type. Token for the connection to the HashiCorp Vault server.

useResponseWrapping

Boolean

If true, the secretID will be unwrapped before saving. Defaults to false.

userName

String

Applicable for cyberark and hashicorp provider types. User name for the connection to the server.

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.createCredentialProvider(
                projectName: 'test-projectName',
                credentialProviderName: 'test-credentialProviderName'
                /* optional arguments */)
▼

deleteCredentialProvider

Deletes a credential provider.

Arguments

Argument Name Type Description

projectName

String

Name of the project that the credential provider belongs to.(Required)

credentialProviderName

String

Unique name of the credential provider within the project.(Required)

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.deleteCredentialProvider(
                projectName: 'test-projectName',
                credentialProviderName: 'test-credentialProviderName')
▼

getCredentialProvider

Retrieves the specified credential provider definition.

Arguments

Argument Name Type Description

projectName

String

Name of the project that the credential provider belongs to.(Required)

credentialProviderName

String

Unique name of the credential provider within the project.(Required)

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.getCredentialProvider(
                projectName: 'test-projectName',
                credentialProviderName: 'test-credentialProviderName')
▼

getCredentialProviders

Retrieves all credential provider definitions in the specified project.

Arguments

Argument Name Type Description

projectName

String

Name of the project that the credential provider belongs to.(Required)

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.getCredentialProviders(
                projectName: 'test-projectName')
▼

modifyCredentialProvider

Modifies an existing credential provider.

Arguments

Argument Name Type Description

projectName

String

Name of the project that the credential provider belongs to.(Required)

credentialProviderName

String

Unique name of the credential provider within the project.(Required)

accountName

String

Applicable for cyberark provider type. Name of the account where the passwords will be retrieved from.

applicationId

String

Applicable for cyberark provider type. Unique application ID that is defined in the vault.

authMethodsMapping

String

Applicable for hashicorp provider type. Mapping in JSON format for authentication methods (for example, {"approle":"some_approle_mapping", "userpass":"some_userpass_mapping"}).

cyberarkProvider

String

Applicable for cyberark provider type. The CyberArk credential provider type or the access provider to use.

cyberarkSafe

String

Applicable for cyberark provider type. Name of the safe where the passwords will be retrieved from.

description

String

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

keyPassword

String

Applicable for cyberark provider type. Password for the key.

namespace

String

Applicable for hashicorp provider type. The namespace within the Vault Enterprise instance to use.

newName

String

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

password

String

Applicable for cyberark and hashicorp provider types. Password for the connection to the server.

providerType

String

Credential provider type.

reason

String

Applicable for cyberark provider type. Reason for credential request.

roleId

String

Applicable for hashicorp provider type. RoleID of the role used by the AppRole authentication mechanism within Vault.

secretEnginePath

String

Applicable for hashicorp provider type. Path at which the specified secret engine is enabled.

secretEngineType

String

Applicable for hashicorp provider type. Name of the secret engine.

secretId

String

Applicable for hashicorp provider type. SecretID used by the AppRole authentication mechanism.

serverUrl

String

Applicable for cyberark and hashicorp provider types. URL for connecting to the credential provider.

store

String

Applicable for cyberark provider type. PKCS 12 storage with certificates and keys for connection to the server.

storePassword

String

Applicable for cyberark provider type. Password for the store.

testConnection

Boolean

Specifies if the connection to the CI server should be tested before saving the configuration. The default is false.

testSecret

String

Applicable for cyberark CCP provider type. Test secret to test the connection for a CCP credential provider type.

token

String

Applicable for hashicorp provider type. Token for the connection to the HashiCorp Vault server.

useResponseWrapping

Boolean

If true, the secretID will be unwrapped before saving. Defaults to false.

userName

String

Applicable for cyberark and hashicorp provider types. User name for the connection to the server.

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.modifyCredentialProvider(
                projectName: 'test-projectName',
                credentialProviderName: 'test-credentialProviderName'
                /* optional arguments */)
▼
credential
dashboard