如何獲取 Jenkins 的 API 令牌
一、概述
Jenkins是一個功能強大的自動化服務器,組織廣泛使用它來自動執行各種任務,例如構建和部署軟件。此外,Jenkins 提供了一個 API 令牌來驗證用戶並授予他們訪問Jenkins API的權限。此外,使用 API 令牌,我們可以創建、管理、查詢和訪問構建工件。
在本教程中,我們將學習在 Jenkins 中生成和使用 API 令牌。
2. 生成 API 令牌
為了訪問 Jenkins API,用戶需要使用 API 令牌對自己進行身份驗證。 API 令牌用作 Jenkins 身份驗證目的的標識符。它通常用於允許第三方應用程序或腳本與 Jenkins 交互,例如觸發構建或訪問構建工件。 Jenkins 管理員可以創建和管理訪問令牌以授予對特定 API 資源的訪問權限。
為了在 Jenkins 中生成 API 令牌,我們需要執行以下步驟:
- 以管理員身份登錄 Jenkins 實例
- 在 Jenkins 儀表板中單擊“管理 Jenkins ”
- 點擊“管理用戶”
- 選擇我們要為其生成 API 令牌的用戶,然後單擊他們的姓名以訪問他們的用戶配置頁面
- 使用用戶配置頁面的“添加新令牌”部分生成令牌
- 單擊“複製”按鈕將令牌複製到剪貼板
-
Save
配置
整個過程在下面的 GUI 中可見:
一旦我們獲得了 API 令牌,我們就可以使用它來驗證對 Jenkins 的請求。我們可以在訪問 Jenkins 遠程 API 時使用令牌來觸發構建或訪問構建工件。此外,確保 API 令牌的安全並且不要與任何不應訪問我們的 Jenkins 帳戶的人共享它也很重要。建議定期輪換我們的 API 令牌以降低**安全風險。**
3. 使用 API 令牌
到目前為止,我們已經成功地為 Jenkins 用戶生成了 API 令牌。我們可以使用 Jenkins 遠程訪問 API 來觸發作業或更新作業的配置。這對於自動化配置過程或將 Jenkins 與其他系統集成很有用。
為了演示,我們將通過向 Jenkins 服務器的/build
端點發送 HTTP POST 請求來觸發構建。該請求將包括 API 令牌以及其他參數。
讓我們看看使用 API 令牌密鑰觸發 Jenkins 作業的請求:
$ curl -X POST http://11.223.231.112:8080/job/testJob/build --user testuser:1100a338c975eb40189c3fe2cf580b2bdf
在上述運行遠程作業的請求中,我們為Jenkins URL
、 job name
和user name
提供了訪問令牌密鑰。
4。結論
在本文中,我們演示瞭如何在 Jenkins 中生成和使用 API 令牌。
首先,我們學習了為 Jenkins 用戶生成 API 令牌。之後,我們使用相同的令牌密鑰遠程觸發了一項工作。