如何获取 Jenkins 的 API 令牌

1. 概述

Jenkins 是一种强大的自动化服务器，组织广泛使用它来自动化各种任务，例如构建和部署软件。此外，Jenkins 提供了 API 密钥来验证用户身份并授予他们访问 Jenkins API 的权限。进一步地，通过 API 密钥，我们可以创建、管理、查询和访问构建成果。

在本文档中，我们将学习如何在 Jenkins 中生成和使用 API 密钥。

2. 生成 API 密钥

为了访问 Jenkins API，用户需要使用 API 密钥进行身份验证。API 密钥作为用于身份验证目的的标识符与 Jenkins 相关联。它经常被用来允许第三方应用程序或脚本与 Jenkins 交互，例如触发构建或访问构建成果。Jenkins 管理员可以创建和管理访问令牌以授予特定 API 资源的访问权限。

为了在 Jenkins 中生成 API 密钥，我们需要遵循以下步骤：

1. 登录到 Jenkins 实例作为管理员。

2. 在 Jenkins 面板中点击“管理 Jenkins”。

3. 点击“管理用户”。

4. 选择我们要为其生成 API 密钥的用户，并点击他们的名称以访问其用户配置页面。

5. 使用用户配置页面上的“添加新密钥”部分生成密钥。

6. 点击“复制”按钮将密钥复制到剪贴板。

7. 保存配置。

整个过程在 GUI 中可见：

获取 API 密钥后，我们就可以使用它来认证对 Jenkins 的请求。我们可以使用密钥来触发构建或在访问 Jenkins 远程 API 时访问构建成果。此外，重要的是要确保 API 密钥安全，并不与不应访问我们 Jenkins 帐户的人共享。建议定期轮换我们的 API 密钥以降低安全风险。

3. 使用 API 密钥

到目前为止，我们成功为 Jenkins 用户生成了 API 密钥。我们可以使用 Jenkins 远程访问 API 来触发工作或更新工作配置。这对于自动化配置过程或将 Jenkins 与其他系统集成非常有用。

为了演示，我们将通过向 Jenkins 服务器的 /build 终端发送 HTTP POST 请求来触发构建。请求将包括 API 密钥以及其它参数。

让我们看看使用 API 密钥键运行远程工作的请求：

$ curl -X POST http://11.223.231.112:8080/job/testJob/build --user testuser:1100a338c975eb40189c3fe2cf580b2bdf

在上述请求中运行远程工作时，我们提供了 Jenkins URL、工作名称 和 用户名，以及访问令牌键。

4. 总结

在本文中，我们展示了如何在 Jenkins 中生成和使用 API 密钥。

首先，我们了解了如何为 Jenkins 用户生成 API 密钥。然后，我们使用相同的密钥键远程触发了工作。