本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。
Atlassian Confluence 雲端動作整合
使用 Atlassian Confluence Cloud 動作連接器,透過自然語言直接在 Amazon Quick 中建立、更新和管理 Confluence 頁面和空格。
若要設定此整合,請先在 Atlassian 開發人員主控台中建立 OAuth 2.0 (3LO) 應用程式,並設定其許可。然後,您可以在 Amazon Quick 中建立整合,並將其連接到您的 Atlassian 應用程式。如需有關 Amazon Quick 支援的身分驗證方法的資訊,請參閱 身分驗證方法。
開始之前
在設定整合之前,請確定您有下列項目。
-
Atlassian Confluence 雲端。
-
存取 Atlassian 開發人員主控台
以建立或管理 OAuth 應用程式。 -
如需訂閱需求,請參閱 在 主控台中設定整合。
設定 Atlassian 開發人員主控台
如果您計劃使用使用者身分驗證 (3LO),請在設定 Amazon Quick 之前,在 Atlassian 開發人員主控台中建立 OAuth 2.0 應用程式。在移至 Amazon Quick 主控台之前,請先完成所有以下步驟。
如果您打算僅使用服務身分驗證 (API 金鑰),您可以略過本節並繼續 準備身分驗證。
如需 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 開發人員主控台中建立此應用程式。
-
開啟 Atlassian 開發人員主控台
,並使用您的 Atlassian 帳戶登入。 -
選擇建立,然後選擇 OAuth 2.0 整合。
-
針對名稱,輸入整合的描述性名稱,例如
。your-app-nameconnector -
檢閱並接受 Atlassian 開發人員術語。
-
選擇建立。
設定 許可
建立 OAuth 2.0 應用程式後,新增 Amazon Quick 與 Atlassian 產品互動所需的 API 許可。
-
在 Atlassian 開發人員主控台的應用程式中,選擇左側導覽中的許可。
-
尋找 Atlassian 產品的 API (例如 Jira API 或 Confluence API),然後選擇新增。新增 API 後,按鈕會變更為設定。
-
選擇設定。範圍頁面會開啟 Classic 範圍和精細範圍索引標籤。
-
在傳統範圍索引標籤上,選擇編輯範圍。選取所需的傳統範圍,然後選擇儲存。
-
選擇精細範圍索引標籤,然後選擇編輯範圍。選取所需的精細範圍,然後選擇儲存。
如需整合所需的特定範圍,請參閱以下範圍一節。
Confluence 的必要範圍
將下列範圍新增至 OAuth 2.0 應用程式,以進行 Confluence Cloud 動作整合。
傳統範圍
在傳統範圍索引標籤上,選擇編輯範圍,然後選取下列範圍。
| Scope (範圍) | Description |
|---|---|
search:confluence |
搜尋 Confluence 內容和空間摘要。 |
精細範圍
選擇精細範圍索引標籤,然後選擇編輯範圍。選取下列範圍。
| Scope (範圍) | Description |
|---|---|
read:page:confluence |
檢視頁面內容。 |
write:page:confluence |
建立和更新頁面。 |
read:space:confluence |
存取空間資訊。 |
設定授權
設定回呼 URL,讓 Atlassian 可以在使用者授權應用程式後,將使用者重新導向回 Amazon Quick。
-
在 Atlassian 開發人員主控台的應用程式中,選擇左側導覽中的授權。
-
在 OAuth 2.0 (3LO) 旁邊,選擇新增。
-
針對回呼 URLs,輸入
https://。將region.quicksight.aws.amazon.com/sn/oauthcallback區域取代為部署 Amazon Quick 執行個體 AWS 的區域,例如us-east-1。 -
選擇儲存變更。
記錄您的登入資料
離開 Atlassian 開發人員主控台之前,請確認您有下列值。您需要它們才能進行 Amazon Quick 組態。
-
從 Atlassian 開發人員主控台中的應用程式,選擇左側導覽中的設定。
-
在身分驗證詳細資訊下,複製用戶端 ID 和秘密值。
| Value | 在哪裡找到它 |
|---|---|
| 用戶端 ID | 設定頁面,在身分驗證詳細資訊下 |
| 秘密 | 設定頁面,在身分驗證詳細資訊下 |
準備身分驗證
Confluence Cloud 動作連接器支援兩種身分驗證方法。在設定 Amazon Quick 之前收集必要的登入資料。
- 使用者身分驗證 (3LO)
-
如果您已完成上一節中的 Atlassian 開發人員主控台設定,您應該準備好下列值。當您在 Amazon Quick 中設定整合時,請輸入這些項目。
基本 URL – API 呼叫的 Confluence 執行個體 URL。這與使用者登入的 URL 不同。它類似以下內容:
https://api.atlassian.com/ex/confluence/。若要尋找您的執行個體 ID,請導覽至yourInstanceIdhttps://。your-domain.atlassian.net/_edge/tenant_info用戶端 ID – 從 Atlassian OAuth 應用程式的設定頁面。
用戶端秘密 – 從 Atlassian OAuth 應用程式的設定頁面。
字符 URL –
https://auth.atlassian.com/oauth/token授權 URL –
https://auth.atlassian.com/authorize重新導向 URL –
https://region.quicksight.aws.amazon.com/sn/oauthcallback
- 服務身分驗證 (API 金鑰)
-
向您的 Confluence Cloud 管理員收集以下資訊:
API 金鑰 – Confluence API 字符。
基本 URL – API 呼叫的 Confluence 執行個體 URL。
電子郵件 – 關聯的使用者帳戶電子郵件。
在 Amazon Quick 中設定整合
準備身分驗證登入資料後,請在 Amazon Quick 中建立整合。
-
在 Amazon Quick 主控台中,選擇整合。
-
選擇動作索引標籤。
-
在為動作設定新的應用程式整合下,尋找 Atlassian Confluence 雲端,然後選擇新增 (加上 "+") 按鈕。
-
在整合類型頁面上,選取在 Atlassian Confluence Cloud 中執行動作,然後選擇下一步。
-
在建立整合表單中,填寫下列欄位:
-
名稱 – Confluence 整合的描述性名稱。
-
描述 (選用) – 有關如何使用此連線的備註。
-
連線類型 – 選擇公有網路。
-
-
在身分驗證設定下,選擇您的身分驗證方法並填寫必要欄位:
-
對於使用者身分驗證,請設定下列欄位:
基本 URL – API 呼叫的 Confluence 執行個體 URL,格式為
https://api.atlassian.com/ex/confluence/。若要尋找您的執行個體 ID,請導覽至yourInstanceIdhttps://。your-domain.atlassian.net/_edge/tenant_info用戶端 ID – 來自 Atlassian OAuth 應用程式設定頁面的用戶端 ID。
用戶端秘密 – 來自 Atlassian OAuth 應用程式設定頁面的秘密。
字符 URL –
https://auth.atlassian.com/oauth/token授權 URL –
https://auth.atlassian.com/authorize重新導向 URL – 此欄位會預先填入您的 Amazon Quick 回呼 URL。
-
對於服務身分驗證,請設定下列欄位:
API 金鑰 – Confluence API 字符。
基本 URL – API 呼叫的 Confluence 執行個體 URL。
電子郵件 – 關聯的使用者帳戶電子郵件。
-
-
選擇建立並繼續。
-
(選用) 在共用整合頁面上,選擇要與之共用整合的使用者。
可用動作
設定整合之後,可以使用下列動作。
| Action | Description |
|---|---|
| 建立頁面 | 建立新的頁面。 |
| 取得頁面 | 檢視所有頁面。 |
| 搜尋 | 使用 CQL 搜尋內容。 |
| 更新頁面 | 更新頁面內容。 |
管理和疑難排解
若要編輯、共用或刪除整合,請參閱 管理現有的整合。
驗證問題
-
應用程式組態不正確 – 驗證 Atlassian 開發人員主控台中的 OAuth 應用程式包含所需的範圍,以及重新導向 URI 是否符合您的 Amazon Quick 組態。
-
過期的 API 字符 – 如果使用服務身分驗證,請檢查 API 字符是否尚未過期,並視需要產生新的字符。
-
不正確的基本 URL – API 呼叫的基本 URL 與 Confluence Cloud 登入 URL 不同。確認您使用的是 API URL 格式:
https://api.atlassian.com/ex/confluence/。若要尋找您的執行個體 ID,請導覽至yourInstanceIdhttps://。your-domain.atlassian.net/_edge/tenant_info
常見錯誤訊息
-
Access denied. You do not have permission to perform this action– 已驗證的使用者在 Confluence Cloud 中沒有必要的許可。請聯絡您的 Confluence Cloud 管理員以驗證並授予適當的許可。 -
OAuth 2.0 authorization failed– 確認在 Atlassian 開發人員主控台和 Amazon Quick 中正確設定用戶端 ID、用戶端秘密和 OAuth 範圍。