createCredentialProvider

Back to index

Summary

Creates a new external credential provider definition for a project.

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.

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. If using an IPv6 address, enclose the 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->createCredentialProvider(
  "test-projectName", # projectName
  "test-credentialProviderName" # credentialProviderName
  # optionals
);▼

ectool

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

Examples

Perl

CyberArk examples

Central Credential Provider (CCP) example:

$cmdr->createCredentialProvider("dev", "deccyberarkCcpTest", {
  applicationId => "testappid",
  cyberarkProvider => "CCP",
  cyberarkSafe => "Test",
  providerType => "CYBERARK",
  serverUrl => "https://example.com:10583",
  testConnection => "0"
});▼

Dynamic Access Provider (DAP):

$cmdr->createCredentialProvider("dev", "deccyberarkCcpTest", {
  applicationId => "testappid",
  cyberarkProvider => "CCP",
  cyberarkSafe => "Test",
  providerType => "CYBERARK",
  serverUrl => "https://example.com:10583",
  testConnection => "0"
});▼

HashiCorp Vault examples

$cmdr->createCredentialProvider("dev", "hashicorpLoginToken_kv2",
{
  providerType => "HASHICORP",
  roleId => null,
  secretEnginePath => "kv_test_2",
  secretEngineType => "KV2",
  serverUrl => "http://localhost:1234",
  userName => null
});▼

ectool

CyberArk examples

Central Credential Provider (CCP) example:

ectool createCredentialProvider dev cyberarkCcpTest \
       --applicationId testappid \
       --serverUrl https://example.com:10583 \
       --testConnection 1 --providerType CYBERARK --cyberarkProvider CCP \
       --storeFile /home/aivanov/client.pfx  --storePassword Cyberark1 \
       --keyPassword Cyberark1 --cyberarkSafe Test▼

Dynamic Access Provider (DAP):

ectool createCredentialProvider dev cyberarkDapTest --accountName dev_acc \
       --serverUrl https://localhost:4433 --userName admin --password dev_pass \
       --testConnection 1 --providerType CYBERARK --cyberarkProvider DAP▼

HashiCorp Vault examples

ectool createCredentialProvider dev hashicorpKvTest \
       --serverUrl http://localhost:1234 --token dev_root_token \
       --testConnection 0 --providerType HASHICORP --secretEngineType KV1 \
       --secretEnginePath kv_test_1▼