createCredential
Creates a new credential for a project.
Arguments
Argument Name | Type | Description |
---|---|---|
projectName |
String |
The name for the project that must be unique among all projects. (Required) |
credentialName |
String |
The name of the credential. (Required) |
credentialProviderName |
String |
Name of the credential provider where the credential secret is stored. |
credentialProviderProjectName |
String |
Name of the credential provider project, if different from the credential project. |
credentialType |
String |
Credential type. Default is LOCAL |
description |
String |
Comment text describing this object that is not interpreted at all by CloudBees CD/RO. |
password |
String |
The password for the credential. Can also be a certificate or any other chunk of data. |
passwordRecoveryAllowed |
Boolean |
If true, recovering the password by invoking getFullCredential from a job step is allowed. |
secretPath |
String |
Name of the folder where the password is stored. |
test |
Boolean |
Applicable if credentialProviderName is specified. Whether to test that the credential exists in the secret management system prior to saving. Defaults to true. |
userName |
String |
The user name for the credential. |
virtualUserName |
String |
Applicable for 'cyberark ccp' provider type. This property identifies two identically provisioned accounts in a dual accounts pair under one virtual username. |
deleteCredential
getCredential
getCredentials
getFullCredential
Find a credential by name from within a running step, including the password.
When invoked in the context of a job step, COMMANDER_JOBSTEPID will be automatically set as the jobStepId argument value unless jobStepId is already specified.
modifyCredential
Modifies an existing credential.
Arguments
Argument Name | Type | Description |
---|---|---|
projectName |
String |
The name for the project that must be unique among all projects. (Required) |
credentialName |
String |
The name of the credential. (Required) |
credentialProviderName |
String |
Name of the credential provider where the credential secret is stored. |
credentialProviderProjectName |
String |
Name of the credential provider project, if different from the credential project. |
credentialType |
String |
Credential type. Default is LOCAL |
description |
String |
Comment text describing this object that is not interpreted at all by CloudBees CD/RO. |
newName |
String |
New name for an existing object that is being renamed. |
password |
String |
The password for the credential. Can also be a certificate or any other chunk of data. |
passwordRecoveryAllowed |
Boolean |
If true, recovering the password by invoking getFullCredential from a job step is allowed. |
secretPath |
String |
Name of the folder where the password is stored. |
test |
Boolean |
Applicable if credentialProviderName is specified. Whether to test that the credential exists in the secret management system prior to saving. Defaults to true. |
userName |
String |
The user name for the credential. |
virtualUserName |
String |
Applicable for 'cyberark ccp' provider type. This property identifies two identically provisioned accounts in a dual accounts pair under one virtual username. |