Creating credentials using Groovy

Issue

Could I create a credential and append it to a folder through a Groovy script?

Environment

  • CloudBees Jenkins Enterprise > 1.609.1.1
  • Jenkins LTS > 1.609.1
  • Jenkins > 1.600

Resolution

It is possible to manipulate credentials using a Groovy script. You can create or edit credentials and add them to Jenkins’s global scope or add them to a domain in a folder. Here are two examples of how to do it.

Example Groovy script to add credentials to Jenkins.

import com.cloudbees.plugins.credentials.impl.*
import com.cloudbees.plugins.credentials.*
import com.cloudbees.plugins.credentials.domains.*

String keyfile = "/tmp/key"

Credentials c = (Credentials) new UsernamePasswordCredentialsImpl(CredentialsScope.GLOBAL,java.util.UUID.randomUUID().toString(), "description", "user", "password")

def ksm1 = new CertificateCredentialsImpl.UploadedKeyStoreSource(keyfile)
Credentials ck1 = new CertificateCredentialsImpl(CredentialsScope.GLOBAL,java.util.UUID.randomUUID().toString(), "description", "password", ksm1)

SystemCredentialsProvider.getInstance().getStore().addCredentials(Domain.global(), c)
SystemCredentialsProvider.getInstance().getStore().addCredentials(Domain.global(), ck1)

Example Groovy script to add credentials to Jenkins’s folder into global domain.

import jenkins.model.*
import com.cloudbees.hudson.plugins.folder.*
import com.cloudbees.hudson.plugins.folder.properties.*
import com.cloudbees.hudson.plugins.folder.properties.FolderCredentialsProvider.FolderCredentialsProperty
import com.cloudbees.plugins.credentials.impl.*
import com.cloudbees.plugins.credentials.*
import com.cloudbees.plugins.credentials.domains.*

jenkins = Jenkins.instance

String id = java.util.UUID.randomUUID().toString()
Credentials c = new UsernamePasswordCredentialsImpl(CredentialsScope.GLOBAL, id, "description:"+id, "user", "password")

for (folder in jenkins.getAllItems(Folder.class)) {
  if(folder.name.equals('FolderName')){
	AbstractFolder<?> folderAbs = AbstractFolder.class.cast(folder)
    FolderCredentialsProperty property = folderAbs.getProperties().get(FolderCredentialsProperty.class)
    property.getStore().addCredentials(Domain.global(), c)
    println property.getCredentials().toString()
  }
}

Example Groovy script to add SSH Username and Private Key credentials to Jenkins.

import com.cloudbees.plugins.credentials.impl.*
import com.cloudbees.plugins.credentials.*
import com.cloudbees.plugins.credentials.domains.*
import com.cloudbees.jenkins.plugins.sshcredentials.impl.*

def source = new BasicSSHUserPrivateKey.DirectEntryPrivateKeySource("key")
def ck1 = new BasicSSHUserPrivateKey(CredentialsScope.GLOBAL,java.util.UUID.randomUUID().toString(), "username", source, "passphrase", "description")

SystemCredentialsProvider.getInstance().getStore().addCredentials(Domain.global(), ck1)

Tested on

The latest update of this article has been tested with:

Was this article helpful?
2 out of 4 found this helpful

Have more questions?

9 Comments

Date Votes
  • 0
    Avatar
    Alexander Ost

    The folder example will only work if the folder already has a FolderCredentialsProperty (e.g., because some credentials were defined from GUI side before). Newly created folders do not have that, and the example will fail.

    How to proceed in that case?

  • 0
    Avatar
    Allan Burdajewicz

    In that case, you can create a new FolderCredentialsProperty - which can take a list of credentials as parameter:

     

    --------

    [...]

    if(property) {
        println "Add credentials in global store"
        property.getStore().addCredentials(Domain.global(), c)
    } else {
        println "Initialize Folder Credentials store and add credentials in global store"
        property = new FolderCredentialsProperty([c])
        folderAbs.addProperty(property)
    }

    --------

     

    See source code of FolderCredentialsProvider.FolderCredentialsProperty

    Edited by Allan Burdajewicz
  • 0
    Avatar
    Marc Sutter

     Hi,

    Thanks for the folder example. It works fine if used as init.groovy.d script. However it doesn't seems to work if used in a jenkinsfile or a groovy dsl file.

    following import fails

    import com.cloudbees.hudson.plugins.folder.properties.FolderCredentialsProvider.FolderCredentialsProperty;

    Any hints how to use it from a groovy dsl script ?

  • 0
    Avatar
    Arnaud Héritier

    Hi Marc,

     

      You have the (CloudBees) Folder plugin installed ? In which version ?

  • 0
    Avatar
    Marc Sutter

    Hi Arnaud,

    I'm running jenkins LTS 2.32.2 with the folder plugin version 5.17. 

    Cheers

  • 0
    Avatar
    Jorge Peña

    How to add a credential domain via groovy ? I want to add a credential domain on a specific folder (Folder -> Credential -> Add domain) and then inside this domain add a credential.

  • 1
    Avatar
    Ott Ramst

    Hi!

    I have a question about this script.

    This script puts the created credential into the 'global' domain. Is there any way to do this for a specific folder domain?

    i.e. I have a folder called 'build-jobs' and it has a credentials domain called 'build-jobs-credentials' and I only want to add credentials under that domain. Is is possible with Groovy?

    Thanks!

  • 0
    Avatar
    Dheeraj Janagam

    Hi

    Instead of randomly generated "ID", how can I have a fixed though this script?

    Something like "userid_prod_usertoken_github-enterprise-prod" #36 char length

    Thanks!

  • 0
    Avatar
    Sonali Prasad17

    Hi,

    Your blog is quite informative, but I see that these are the ways if you want to add credentials globally or for a folder, what about the project/job then? Will you please mention the script for how can we generate credentials that are specific to job/project.
    Thanks in advance.

Please sign in to leave a comment.