Index
addResourcePoolToEnvironmentTieraddResourceTemplateToEnvironmentTemplateTieraddResourceToEnvironmentTemplateTiercreateEnvironmentTemplatecreateEnvironmentTemplateTiercreateEnvironmentTemplateTierMapcreateHookcreateResourceTemplatedeleteEnvironmentTemplatedeleteEnvironmentTemplateTierdeleteEnvironmentTemplateTierMapdeleteEnvironmentTemplateTierMappingdeleteHookdeleteResourceTemplategetAvailableResourcesForEnvironmentgetEnvironmentTemplategetEnvironmentTemplatesgetEnvironmentTemplateTiergetEnvironmentTemplateTierMapsgetEnvironmentTemplateTiersgetHookgetHooksgetProvisionedEnvironmentsgetResourcePoolsInEnvironmentTiergetResourcesInEnvironmentTemplateTiergetResourceTemplategetResourceTemplatesgetResourceTemplatesInEnvironmentTemplateTiermodifyEnvironmentTemplatemodifyEnvironmentTemplateTiermodifyEnvironmentTemplateTierMapmodifyEnvTemplTierResourceTemplMappingmodifyHookmodifyResourceTemplateprovisionEnvironmentprovisionResourcePoolremoveResourceFromEnvironmentTemplateTierremoveResourcePoolFromEnvironmentTierremoveResourceTemplateFromEnvironmentTemplateTier
getPluginCatalog
getServerSettingsCategories
processWebhookTrigger
getWorkItems

modifyCredentialProvider

Back to index

Summary

Modifies an existing credential provider.
projectName
Stringrequired
Name of the project that the credential provider belongs to.
credentialProviderName
Stringrequired
Unique name of the credential provider within the project.
accountName
Stringoptional
Applicable for cyberark provider type. Name of the account where the passwords will be retrieved from.
applicationId
Stringoptional
Applicable for cyberark provider type. Unique application ID that is defined in the vault.
authMethodsMapping
Stringoptional
Applicable for hashicorp provider type. Mapping in JSON format for authentication methods (for example, {"approle":"some_approle_mapping", "userpass":"some_userpass_mapping"}).
cyberarkProvider
Stringoptional
Applicable for cyberark provider type. The CyberArk credential provider type or the access provider to use.
Possible values: "CCP", "DAP"
cyberarkSafe
Stringoptional
Applicable for cyberark provider type. Name of the safe where the passwords will be retrieved from.
description
Stringoptional
Comment text describing this object that is not interpreted at all by CloudBees CD/RO.
keyPassword
Stringoptional
Applicable for cyberark provider type. Password for the key.
namespace
Stringoptional
Applicable for hashicorp provider type. The namespace within the Vault Enterprise instance to use.
newName
Stringoptional
The new name for an existing object that is being renamed.
password
Stringoptional
Applicable for cyberark and hashicorp provider types. Password for the connection to the server.
providerType
Stringoptional
Credential provider type.
Possible values: "CYBERARK", "HASHICORP"
reason
Stringoptional
Applicable for cyberark provider type. Reason for credential request.
roleId
Stringoptional
Applicable for hashicorp provider type. RoleID of the role used by the AppRole authentication mechanism within Vault.
secretEnginePath
Stringoptional
Applicable for hashicorp provider type. Path at which the specified secret engine is enabled.
secretEngineType
Stringoptional
Applicable for hashicorp provider type. Name of the secret engine.
Possible values: "CUBBYHOLE", "KV1", "KV2"
secretId
Stringoptional
Applicable for hashicorp provider type. SecretID used by the AppRole authentication mechanism.
serverUrl
Stringoptional
Applicable for cyberark and hashicorp provider types. URL for connecting to the credential provider. Enclose the IPV6 address in square brackets. Example: [<IPv6-ADDRESS>].
store
Stringoptional
Applicable for cyberark provider type. PKCS 12 storage with certificates and keys for connection to the server.
storePassword
Stringoptional
Applicable for cyberark provider type. Password for the store.
testConnection
Booleanoptional
Specifies if the connection to the CI server should be tested before saving the configuration. The default is false.
testSecret
Stringoptional
Applicable for cyberark CCP provider type. Test secret to test the connection for a CCP credential provider type.
token
Stringoptional
Applicable for hashicorp provider type. Token for the connection to the HashiCorp Vault server.
useResponseWrapping
Booleanoptional
If true, the secretID will be unwrapped before saving. Defaults to false.
userName
Stringoptional
Applicable for cyberark and hashicorp provider types. User name for the connection to the server.

Usage

Perl

$cmdr->modifyCredentialProvider(
  "test-projectName", # projectName
  "test-credentialProviderName" # credentialProviderName
  # optionals
);
▼

ectool

ectool modifyCredentialProvider \
  "test-projectName" `# projectName` \
  "test-credentialProviderName" `# credentialProviderName` \
  # optionals
▼

Examples

Perl

$cmdr->modifyCredentialProvider("dev", "deccyberarkCcpTest", {
  serverUrl => "https://example.com:3456"});
▼

ectool

ectool modifyCredentialProvider dev cyberarkCcpTest \
       --serverUrl https://example.com:3456
▼