API token management in Jenkins - Mini Project: Build & Apply

API Token Management in Jenkins

📖 Scenario: You are a Jenkins administrator managing API tokens for users to securely access Jenkins remotely.API tokens allow users to authenticate without using their passwords, improving security.

🎯 Goal: Learn how to create, configure, and display API tokens for Jenkins users using Jenkins CLI commands.

📋 What You'll Learn

Use Jenkins CLI commands to manage API tokens

Create a new API token for a user

List existing API tokens for a user

Display the created API token securely

💡 Why This Matters

🌍 Real World

Managing API tokens is essential for secure automation and remote access in Jenkins environments.

💼 Career

DevOps engineers and Jenkins administrators regularly create and manage API tokens to enable secure integrations and automation.

1

Create a new API token for user

Use the Jenkins CLI command jenkins-cli create-api-token --username alice --token-name mytoken to create a new API token named mytoken for the user alice.

Jenkins

# Run the command to create a new API token for user alice
# Your code here

Hint

Use the Jenkins CLI tool with the create-api-token command, specifying the username and token name exactly as shown.

2

Configure token display variable

Assign the output of the command jenkins-cli list-api-tokens --username alice to a variable called tokens to hold the list of API tokens for user alice.

Jenkins

jenkins-cli create-api-token --username alice --token-name mytoken
# Assign the list of API tokens for alice to variable tokens
# Your code here

Hint

Use command substitution to assign the output of jenkins-cli list-api-tokens --username alice to the variable tokens.

3

Extract the new token from the list

Use a command to filter the variable tokens and extract the API token named mytoken into a variable called new_token. Use grep and awk commands.

Jenkins

jenkins-cli create-api-token --username alice --token-name mytoken
tokens=$(jenkins-cli list-api-tokens --username alice)
# Extract the token named mytoken into new_token
# Your code here

Hint

Use grep mytoken to find the line with the token name, then awk '{print $2}' to get the token value.

4

Display the new API token

Print the value of the variable new_token using echo to display the created API token.

Jenkins

jenkins-cli create-api-token --username alice --token-name mytoken
tokens=$(jenkins-cli list-api-tokens --username alice)
new_token=$(echo "$tokens" | grep mytoken | awk '{print $2}')
# Print the new_token value
# Your code here

Hint

Use echo "$new_token" to print the token value.

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