Index
aclaclEntryactualParameteraddCredentialanalyticsServerConfigurationapplicationapplicationDependencyapplicationTierarchiveConnectorartifactartifactVersioncatalogcatalogItemciConfigurationclustercomplianceConfigurationcomponentcredentialcredentialProviderdashboarddataRetentionPolicydeployerApplicationdeployerConfigurationdevOpsInsightDataSourcedevOpsInsightServerConfigurationdirectoryProvideremailConfigemailNotifierenvironmentenvironmentTemplateenvironmentTemplateTierenvironmentTemplateTierMapenvironmentTemplateTierMappingenvironmentTierformalOutputParameterformalParametergategatewaygrouphookjobjobSteplicensemicroservicemicroserviceMappingnoteopenIDConnectConfigurationpersonapersonaCategorypersonaPagepipelinepluginpluginConfigurationprocedureprocessprocessDependencyprocessStepprojectpropertyreleasereportreportingFilterreportObjectAssociationreportObjectAttributereportObjectTyperepositoryreservationresourceresourcePoolresourceTemplaterollingDeployPhasesamlIdentityProvidersamlServiceProviderschedulescmSyncsearchFilterserviceAccountsnapshotstagestateDefinitionsteptagtasktierMaptierMappingtransitionDefinitiontriggeruseruserEmailutilityResourcewaitDependencywidgetwidgetFilterOverrideworkflowDefinitionworkspacezone

addCredential

On this page
Back to index

Summary

A username/password stored in the server as encrypted data. Typically used in an agent context to authenticate with a third-party system. The password is not available in the web context for security reasons, so this object has no getPassword method.
credentialName
Stringrequired
The name of the credential.
pluginConfigurationName
Stringrequired
Unique name of the plugin configuration within the project.
projectName
Stringrequired
The name for the project that must be unique among all projects.
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.
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
Stringoptional
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
Stringoptional
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

There are no usage examples available for addCredential.