Atlassian Jira Cloud 整合 - Amazon Quick

本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。

Atlassian Jira Cloud 整合

使用 Atlassian Jira Cloud 動作連接器,透過自然語言直接在 Amazon Quick 中建立、更新、搜尋和管理 Jira 問題、專案、衝刺和使用者。

設定此整合包含兩個步驟。首先,在 Atlassian 開發人員主控台中建立 OAuth 2.0 (3LO) 應用程式並設定其許可。然後,您可以在 Amazon Quick 中建立整合,並將其連接到您的 Atlassian 應用程式。如需有關 Amazon Quick 支援的身分驗證方法的資訊,請參閱 身分驗證方法

開始之前

在設定整合之前,請確定您有下列項目。

設定 Atlassian 開發人員主控台

如果您計劃使用使用者身分驗證 (3LO),請在設定 Amazon Quick 之前,在 Atlassian 開發人員主控台中建立 OAuth 2.0 應用程式。在移至 Amazon Quick 主控台之前,請先完成所有以下步驟。

如果您打算僅使用服務身分驗證 (API 金鑰),您可以略過本節並繼續 在 Amazon Quick 中設定整合

如需 OAuth 2.0 (3LO) 應用程式的詳細資訊,請參閱 Atlassian 開發人員文件中的 OAuth 2.0 (3LO) 應用程式

建立 OAuth 2.0 (3LO) 應用程式

Amazon Quick 使用 Atlassian OAuth 2.0 (3LO) 應用程式,代表您的使用者使用您的 Atlassian Cloud 產品進行身分驗證。在設定 Amazon Quick 之前,請在 Atlassian 開發人員主控台中建立此應用程式。

  1. 開啟 Atlassian 開發人員主控台,並使用您的 Atlassian 帳戶登入。

  2. 選擇建立,然後選擇 OAuth 2.0 整合。

  3. 針對名稱,輸入整合的描述性名稱,例如 your-app-name connector

  4. 檢閱並接受 Atlassian 開發人員術語。

  5. 選擇建立

設定 許可

建立 OAuth 2.0 應用程式後,新增 Amazon Quick 與 Atlassian 產品互動所需的 API 許可。

  1. 在 Atlassian 開發人員主控台的應用程式中,選擇左側導覽中的許可

  2. 尋找 Atlassian 產品的 API (例如 Jira APIConfluence API),然後選擇新增。新增 API 後,按鈕會變更為設定

  3. 選擇設定。範圍頁面會開啟 Classic 範圍精細範圍索引標籤。

  4. 傳統範圍索引標籤上,選擇編輯範圍。選取所需的傳統範圍,然後選擇儲存

  5. 選擇精細範圍索引標籤,然後選擇編輯範圍。選取所需的精細範圍,然後選擇儲存

如需整合所需的特定範圍,請參閱以下範圍一節。

設定 API 許可

將下列範圍新增至 OAuth 2.0 應用程式,以進行 Jira Cloud 動作整合。

傳統範圍

傳統範圍索引標籤上,選擇編輯範圍,然後選取下列範圍。

Jira 動作整合 – 傳統範圍
Scope (範圍) Description
read:jira-work 讀取 Jira 專案並發出資料、搜尋問題,以及與附件和工作日誌等問題相關聯的物件。
manage:jira-project 建立和編輯專案設定,並建立新的專案層級物件 (例如版本和元件)。
manage:jira-configuration 採取 Jira 管理動作 (例如,建立專案和自訂欄位、檢視工作流程、管理問題連結類型)。
read:jira-user 在 Jira 中檢視使用者可存取的使用者資訊,包括使用者名稱、電子郵件地址和頭像。
write:jira-work 在 Jira 中建立和編輯問題、以使用者身分張貼評論、建立工作日誌,以及刪除問題。
manage:jira-webhook 擷取、註冊、重新整理和刪除動態宣告的 Jira Webhook。

精細範圍

選擇精細範圍索引標籤,然後選擇編輯範圍。使用搜尋列尋找以下範圍。例如,搜尋 sprint:jira-software 尋找與衝刺相關的範圍。

Jira 動作整合 – 精細範圍
Scope (範圍) Description
read:board-scope:jira-software 讀取電路板組態。
read:sprint:jira-software 讀取衝刺資訊。
write:sprint:jira-software 建立和修改衝刺。
delete:sprint:jira-software 刪除衝刺。
write:board-scope:jira-software 管理主機板組態。
read:project:jira 讀取專案詳細資訊。

設定授權

設定回呼 URL,讓 Atlassian 可以在使用者授權應用程式後,將使用者重新導向回 Amazon Quick。

  1. 在 Atlassian 開發人員主控台的應用程式中,選擇左側導覽中的授權

  2. OAuth 2.0 (3LO) 旁邊,選擇新增

  3. 針對回呼 URLs,輸入 https://region.quicksight.aws.amazon.com/sn/oauthcallback。將區域取代為部署 Amazon Quick 執行個體 AWS 的區域,例如 us-east-1

  4. 選擇儲存變更

記錄您的登入資料

離開 Atlassian 開發人員主控台之前,請確認您有下列值。您需要它們才能進行 Amazon Quick 組態。

  1. 從 Atlassian 開發人員主控台中的應用程式,選擇左側導覽中的設定

  2. 身分驗證詳細資訊下,複製用戶端 ID秘密值。

Atlassian 開發人員主控台的必要登入資料
Value 在哪裡找到它
用戶端 ID 設定頁面,在身分驗證詳細資訊下
秘密 設定頁面,在身分驗證詳細資訊下

在 Amazon Quick 中設定整合

準備身分驗證登入資料後,請在 Amazon Quick 中建立整合。

  1. 在 Amazon Quick 主控台中,選擇整合

  2. 選擇動作索引標籤。

  3. 為動作設定新的應用程式整合下,尋找 Atlassian Jira Cloud 並選擇新增 (加 "+") 按鈕。

  4. 建立整合精靈中,填寫下列欄位:

    • 名稱 – Jira 整合的描述性名稱。

    • 描述 (選用) – 有關如何使用此連線的備註。

    • 連線類型 – 選擇公有網路

  5. 身分驗證設定下,選擇您的身分驗證方法並填寫必要欄位:

    1. 對於使用者身分驗證,請設定下列欄位:

      • 基本 URL – API 呼叫的 Jira 執行個體 URL。這與使用者登入的 URL 不同。它類似以下內容:https://api.atlassian.com/ex/jira/yourInstanceId。若要尋找您的執行個體 ID,請導覽至 https://your-domain.atlassian.net/_edge/tenant_info

      • 用戶端 ID – 來自 Atlassian OAuth 應用程式設定頁面的用戶端 ID。

      • 用戶端秘密 – 來自 Atlassian OAuth 應用程式設定頁面的秘密。

      • 權杖 URLhttps://auth.atlassian.com/oauth/token

      • 授權 URLhttps://auth.atlassian.com/authorize

      • 重新導向 URL – 此欄位會預先填入您的 Amazon Quick 回呼 URL。

    2. 對於服務身分驗證,請設定下列欄位:

      • API 金鑰 – Jira API 字符。

      • 基本 URL – API 呼叫的 Jira 執行個體 URL。

      • 電子郵件 – 關聯的使用者帳戶電子郵件。

  6. 選擇建立並繼續

  7. (選用) 在共用整合頁面上,選擇要與之共用整合的使用者。

重要

即使 API 權杖遭到撤銷或設定不當,Jira Cloud 仍可能會傳回 HTTP 200 成功回應。如需詳細資訊,請參閱 JRACLOUD-82932。如果您的整合顯示連線成功,但動作意外失敗,請確認您的 API 權杖有效且尚未撤銷。

可用動作

設定整合之後,可以使用下列動作。

Jira Cloud 可用的動作
Action Description
新增附件 將附件新增至問題。
新增註解 新增註解。
變更問題狀態 變更問題的任務狀態。
建立問題 建立新的問題或子任務。
建立專案 建立新的專案。
建立衝刺 在專案中建立衝刺。
刪除註解 移除註解。
刪除問題 刪除專案中的問題。
刪除專案 移除專案。
刪除衝刺 刪除專案中的衝刺。
編輯問題 修改問題。
尋找使用者 搜尋 Jira 使用者。
取得所有標籤 檢視所有標籤。
取得所有使用者 列出所有 Jira 使用者。
取得附件內容 檢視附件的內容。
取得評論 檢視問題註解。
取得問題 檢視專案中問題的詳細資訊。
取得專案的問題類型 檢視專案問題類型。
取得優先順序 檢視問題優先順序。
取得專案 檢視專案詳細資訊。
取得衝刺 檢視專案中衝刺的詳細資訊。
將問題移至待處理項目 將問題移至待處理項目。
將問題移至衝刺和排名 將問題指派給衝刺。
搜尋問題 搜尋問題。
搜尋專案 尋找可見的專案。
搜尋狀態 搜尋問題狀態。
更新註解 編輯註解。
更新專案 修改專案。
更新衝刺 更新衝刺詳細資訊。
注意

您可以使用的動作取決於 Jira Cloud 執行個體中設定的許可和身分驗證方法。

管理和疑難排解

若要編輯、共用或刪除整合,請參閱 管理現有的整合

驗證問題

  • 應用程式組態不正確 – 驗證 Atlassian 開發人員主控台中的 OAuth 應用程式包含所需的範圍,以及重新導向 URI 是否符合您的 Amazon Quick 組態。

  • 過期或撤銷的 API 字符 – 如果使用服務身分驗證,請檢查 API 字符是否尚未過期或已撤銷。由於已知的 Jira Cloud 行為 (JRACLOUD-82932),即使字符無效,整合仍可能成功連線。

  • 不正確的基本 URL – API 呼叫的基本 URL 與 Jira Cloud 登入 URL 不同。確認您使用的是 API URL 格式:https://api.atlassian.com/ex/jira/yourInstanceId。若要尋找您的執行個體 ID,請導覽至 https://your-domain.atlassian.net/_edge/tenant_info

常見錯誤訊息

  • Access denied. You do not have permission to perform this action – 已驗證的使用者在 Jira Cloud 中沒有必要的許可。請聯絡您的 Jira Cloud 管理員以驗證並授予適當的許可。

  • OAuth 2.0 authorization failed – 確認在 Atlassian 開發人員主控台和 Amazon Quick 中正確設定用戶端 ID、用戶端秘密和 OAuth 範圍。