API token management in Jenkins - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is an API token in Jenkins?

An API token in Jenkins is a secret key used to authenticate API requests without using your password. It helps keep your account secure when accessing Jenkins programmatically.

beginner

How do you create a new API token in Jenkins?

Go to your Jenkins user profile, click on 'Configure', then find the 'API Token' section. Click 'Add new Token', give it a name, and Jenkins will generate a new token for you to copy and use.

beginner

Why should you avoid sharing your Jenkins API token?

Because the API token grants access to your Jenkins account and its permissions. Sharing it can let others perform actions on your behalf, risking security and data integrity.

intermediate

How can you revoke an API token in Jenkins?

In your Jenkins user profile under 'Configure', find the list of API tokens. Click the 'Revoke' button next to the token you want to disable. This stops the token from working immediately.

beginner

What is a practical use of Jenkins API tokens?

They are used to authenticate automated scripts or tools that interact with Jenkins, like triggering builds or fetching job status, without exposing your password.

Where do you find the option to create a new API token in Jenkins?

A In the Jenkins dashboard main page

B In the Jenkins system settings

C In the job configuration page

D In your user profile under 'Configure'

API tokens are managed in your user profile under the 'Configure' section.

What should you do if you suspect your Jenkins API token is compromised?

A Revoke the token immediately

B Change your Jenkins password only

C Ignore it if no suspicious activity is seen

D Create a new Jenkins user

Revoking the compromised token stops unauthorized access immediately.

Which of the following is NOT a reason to use API tokens instead of passwords in Jenkins automation?

A API tokens can be revoked without changing your password

B API tokens limit exposure of your main password

C API tokens are easier to remember than passwords

D API tokens allow secure programmatic access

API tokens are usually long and random, so they are not easier to remember than passwords.

How does Jenkins treat API tokens when authenticating API requests?

A As a substitute for your password

B As a username

C As a job parameter

D As a build trigger

API tokens act as a password substitute for API authentication.

What happens if you revoke an API token in Jenkins?

A The token remains active for 24 hours

B The token stops working immediately

C The token is deleted but still works

D The token is converted to a password

Revoking disables the token immediately to prevent further use.

Explain the steps to create and use an API token in Jenkins for automation.

Think about where you manage your Jenkins user settings.

Describe why managing API tokens carefully is important for Jenkins security.

Consider what could happen if someone else gets your token.

Practice

1. What is the main purpose of an API token in Jenkins?

easy

A. To allow secure access to Jenkins without using your password

B. To reset your Jenkins user password automatically

C. To create new Jenkins user accounts

D. To monitor Jenkins server performance

Solution

1. Step 1: Understand API token function

   An API token acts like a password substitute for accessing Jenkins securely.

2. Step 2: Compare options

   Only To allow secure access to Jenkins without using your password correctly describes the token's purpose; others describe unrelated functions.

3. Final Answer:

   To allow secure access to Jenkins without using your password -> Option A

4. Quick Check:

   API token = secure password substitute [OK]

Hint: API tokens replace passwords for safe Jenkins access [OK]

Common Mistakes:

• Thinking tokens reset passwords
• Confusing tokens with user creation
• Assuming tokens monitor performance

2. Which Jenkins menu path lets you create a new API token?

easy

A. Manage Jenkins > Configure System

B. Dashboard > New Item

C. User Profile > Configure > API Token

D. Manage Plugins > Available

Solution

1. Step 1: Locate API token creation

   API tokens are created in the user's own profile settings, not global or plugin menus.

2. Step 2: Match correct menu path

   Only User Profile > Configure > API Token correctly points to User Profile > Configure > API Token.

3. Final Answer:

   User Profile > Configure > API Token -> Option C

4. Quick Check:

   API tokens created in user profile [OK]

Hint: API tokens are in your user profile settings [OK]

Common Mistakes:

• Looking under Manage Jenkins instead of user profile
• Confusing plugin menus with token creation
• Trying to create tokens from dashboard

3. What will happen if you use an invalid API token in a Jenkins REST API call?

medium

A. The API call succeeds but with limited permissions

B. The API call fails with an authentication error

C. The API call triggers a password reset

D. The API call is queued for later processing

Solution

1. Step 1: Understand token validation

   Jenkins checks API tokens for validity before allowing access.

2. Step 2: Identify failure behavior

   Invalid tokens cause authentication failure, so the call is rejected.

3. Final Answer:

   The API call fails with an authentication error -> Option B

4. Quick Check:

   Invalid token = authentication error [OK]

Hint: Invalid tokens cause authentication errors [OK]

Common Mistakes:

• Assuming calls succeed with limited access
• Thinking invalid tokens reset passwords
• Believing calls queue instead of failing

4. You created an API token but Jenkins shows 'Invalid token' error when using it. What is the most likely cause?

medium

A. You copied the token incorrectly or partially

B. You used the token in the Jenkins UI instead of API calls

C. You created the token in the wrong Jenkins instance

D. You forgot to restart Jenkins after creating the token

Solution

1. Step 1: Check token usage errors

   Common error is copying the token incorrectly, causing invalid token errors.

2. Step 2: Evaluate other options

   Tokens work immediately without restart; UI usage is different; wrong instance is less common.

3. Final Answer:

   You copied the token incorrectly or partially -> Option A

4. Quick Check:

   Copy error = invalid token [OK]

Hint: Always copy API tokens fully and exactly [OK]

Common Mistakes:

• Restarting Jenkins unnecessarily
• Using tokens in UI login fields
• Ignoring token instance mismatch

5. You want to revoke an old API token without affecting other tokens. How do you do this safely in Jenkins?

hard

A. Disable your Jenkins user account temporarily

B. Change your Jenkins user password to invalidate all tokens

C. Restart Jenkins to clear all active tokens

D. Delete the specific token from your user profile's API token list

Solution

1. Step 1: Understand token revocation

   Jenkins allows deleting individual API tokens from your user profile without affecting others.

2. Step 2: Compare other methods

   Changing password invalidates all tokens; restarting Jenkins or disabling account are not selective.

3. Final Answer:

   Delete the specific token from your user profile's API token list -> Option D

4. Quick Check:

   Delete token individually to revoke safely [OK]

Hint: Revoke tokens individually via user profile [OK]

Common Mistakes:

• Changing password to revoke one token
• Restarting Jenkins unnecessarily
• Disabling user instead of token