Credential scoping (global, folder) in Jenkins - Commands & Configuration

Introduction

Jenkins uses credentials to store secrets like passwords or tokens safely. Credential scoping controls where these secrets can be used, either everywhere (global) or only in specific folders, helping keep secrets secure and organized.

When you want a secret to be available to all jobs in Jenkins, like a global API key.

When you want to limit a secret to only jobs inside a specific folder to reduce risk.

When you have multiple teams using the same Jenkins instance and want to separate their secrets.

When you want to avoid accidental use of sensitive credentials outside their intended scope.

When you want to organize credentials by project or team using folder-level scoping.

Commands

This command adds a credential with global scope to Jenkins using an XML file. Global scope means the credential is available to all jobs and folders.

Terminal

jenkins-cli create-credentials-by-xml system::system::jenkins _ < global-credentials.xml

Expected Output

Created credentials with ID 'global-api-key'

→

system::system::jenkins - Specifies the Jenkins system scope for global credentials

This command adds a credential scoped only to the folder named 'my-folder'. Only jobs inside this folder can use this credential.

Terminal

jenkins-cli create-credentials-by-xml folder:my-folder _ < folder-credentials.xml

Expected Output

Created credentials with ID 'folder-db-password'

→

folder:my-folder - Specifies the folder scope for the credential

Lists all credentials with global scope in Jenkins so you can verify the global credentials exist.

Terminal

jenkins-cli list-credentials system::system::jenkins

Expected Output

[global-api-key]

Lists all credentials scoped to the folder 'my-folder' to verify folder-level credentials.

Terminal

jenkins-cli list-credentials folder:my-folder

Expected Output

[folder-db-password]

Key Concept

If you remember nothing else from this pattern, remember: global credentials are accessible everywhere, but folder-scoped credentials limit access to only jobs inside that folder for better security.

Common Mistakes

Adding sensitive credentials with global scope when they should be limited to a folder.

This exposes secrets to all jobs, increasing security risks.

Use folder-scoped credentials to restrict access only to jobs that need them.

Trying to use a folder-scoped credential in a job outside that folder.

The job cannot access the credential and will fail authentication.

Ensure the job is inside the folder where the credential is scoped or use a global credential.

Not verifying credential scope after creation.

You might think a credential is available when it is not, causing build failures.

Use list-credentials commands to confirm the credential scope.

Summary

Use global scope for credentials needed by all jobs in Jenkins.

Use folder scope to limit credentials to specific folders and improve security.

Verify credential creation and scope with Jenkins CLI list commands.

Practice

1. What does Global credential scope mean in Jenkins?

easy

A. The credential can be used by any job in Jenkins.

B. The credential is only available to jobs in a specific folder.

C. The credential is only available to the Jenkins administrator.

D. The credential expires after one use.

Solution

1. Step 1: Understand credential scopes

   Global scope means credentials are accessible everywhere in Jenkins.

2. Step 2: Compare with folder scope

   Folder scope limits credentials to jobs inside that folder only.

3. Final Answer:

   The credential can be used by any job in Jenkins. -> Option A

4. Quick Check:

   Global scope = accessible to all jobs [OK]

Hint: Global means all jobs can use it, no folder limits [OK]

Common Mistakes:

• Confusing global with folder scope
• Thinking global is admin-only
• Assuming credentials expire automatically

2. Which of the following is the correct way to assign a credential to a folder in Jenkins?

easy

A. Add the credential under Jenkins > Credentials > System > Global credentials

B. Add the credential inside the folder's Credentials section

C. Add the credential in the job configuration only

D. Add the credential in Jenkins > Manage Plugins

Solution

1. Step 1: Locate folder credentials

   Folder scoped credentials are added inside the folder's own Credentials section.

2. Step 2: Differentiate from global credentials

   Global credentials are added under Jenkins system credentials, not folder.

3. Final Answer:

   Add the credential inside the folder's Credentials section -> Option B

4. Quick Check:

   Folder credentials go inside folder settings [OK]

Hint: Folder credentials must be added inside that folder [OK]

Common Mistakes:

• Adding folder credentials to global system store
• Trying to add credentials in job config only
• Confusing plugin management with credentials

3. Given a folder named ProjectA with a credential scoped to it, what happens if a job outside ProjectA tries to use that credential?

medium

A. The job can use the credential without restrictions.

B. The job will use a default global credential instead.

C. The job will fail to access the credential.

D. The job will prompt the user to enter the credential manually.

Solution

1. Step 1: Understand folder scope restrictions

   Folder scoped credentials are only accessible to jobs inside that folder.

2. Step 2: Check job location

   A job outside the folder cannot access folder-scoped credentials.

3. Final Answer:

   The job will fail to access the credential. -> Option C

4. Quick Check:

   Folder scope blocks jobs outside folder [OK]

Hint: Folder credentials block jobs outside folder [OK]

Common Mistakes:

• Assuming folder credentials are global
• Thinking Jenkins auto-fills missing credentials
• Believing jobs can prompt for credentials

4. You added a credential to a folder but jobs inside the folder still cannot access it. What is the most likely cause?

medium

A. The folder permissions prevent jobs from using credentials.

B. The jobs are not inside the folder where the credential was added.

C. The credential was added with global scope instead of folder scope.

D. The credential type is unsupported by Jenkins.

Solution

1. Step 1: Verify credential scope

   If credential is in folder, scope is correct; global scope would make it accessible everywhere.

2. Step 2: Check folder permissions

   Folder permissions can restrict job access to credentials even if scope is correct.

3. Final Answer:

   The folder permissions prevent jobs from using credentials. -> Option A

4. Quick Check:

   Permissions can block credential use inside folder [OK]

Hint: Check folder permissions if folder credentials fail [OK]

Common Mistakes:

• Assuming scope is wrong without checking permissions
• Ignoring folder membership of jobs
• Thinking Jenkins blocks unsupported credential types silently

5. You want to restrict a credential so only jobs in the DevOps folder and its subfolders can use it, but not jobs elsewhere. How should you configure the credential?

hard

A. Add the credential in each job configuration inside DevOps.

B. Add the credential with global scope and restrict job permissions manually.

C. Add the credential with system scope to limit access.

D. Add the credential with folder scope inside the DevOps folder.

Solution

1. Step 1: Understand folder scope for restriction

   Folder scope limits credential use to jobs inside that folder and its subfolders.

2. Step 2: Avoid global or system scope

   Global scope allows all jobs; system scope is not a valid Jenkins credential scope.

3. Step 3: Avoid per-job credentials for manageability

   Adding credentials per job is inefficient and error-prone.

4. Final Answer:

   Add the credential with folder scope inside the DevOps folder. -> Option D

5. Quick Check:

   Folder scope limits credential to folder and subfolders [OK]

Hint: Use folder scope inside DevOps folder for restriction [OK]

Common Mistakes:

• Using global scope and relying on permissions only
• Confusing system scope with folder scope
• Adding credentials individually to jobs