Microsoft Entra SSO 與 Redocly 整合

在本文中，您將瞭解如何整合 Redocly 與 Microsoft Entra ID。 Redocly 是第一個開發人員文件工具，可讓我們將文件保存在 GitHub 中，讓開發人員隨時可取得開發人員文件。 整合 Redocly 與 Microsoft Entra ID 時，您可以：

• 在 Microsoft Entra ID 中控制可以存取 Redocly 的人員。
• 讓使用者使用其 Microsoft Entra 帳戶自動登入 Redocly。
• 在一個集中式位置管理您的帳戶。

您將在測試環境中設定及測試適用於 Redocly 的 Microsoft Entra 單一登入。 Redocly 支援 SP 起始的單一登入和 Just In Time 使用者佈建。

必要條件

若要整合 Microsoft Entra ID 與 Redocly，您需要：

• Microsoft Entra 使用者帳戶。 若尚未有帳戶，可以免費建立帳戶。
• 下列角色其中之一：應用程式管理員、雲端應用程式管理員 或 應用程式擁有者。
• Microsoft Entra 訂用帳戶。 如果您沒有訂用帳戶，可以取得免費帳戶。
• 已啟用 Redocly 單一登入 (SSO) 的訂用帳戶。

新增應用程式並指派測試使用者

開始設定單一登入的程式之前，您需要從 Microsoft Entra 資源庫新增 Redocly 應用程式。 您需要將測試使用者帳戶指派給應用程式，並測試單一登入設定。

從 Microsoft Entra 資源庫新增 Redocly

從 Microsoft Entra 應用程式資源庫新增 Redocly，以設定 Redocly 的單一登入。 如需如何從資源庫新增應用程式的詳細資訊，請參閱快速入門：從資源庫新增應用程式。

建立並指派 Microsoft Entra 測試使用者

請遵循 建立和指派使用者帳戶 一文中的指導方針，建立名為 B.Simon 的測試使用者帳戶。

或者，您也可以使用企業應用程式組態精靈。 在此精靈中，您可以將應用程式新增至租用戶、將使用者/群組新增至應用程式，以及指派角色。 精靈也會提供單一登入組態窗格的連結。 深入了解 Microsoft 365 精靈。

設定 Microsoft Entra SSO

完成下列步驟以啟用 Microsoft Entra 單一登入。

1. 以至少 雲端應用程式系統管理員 的身分登入 Microsoft Entra 系統管理中心。

2. 瀏覽至 [身分識別]>[應用程式] >[企業應用程式]>[Redocly] >[單一登入]。

3. 在 [選取單一登入方法] 頁面上，選取 [SAML]。

4. 在 [以 SAML 設定單一登入] 頁面上，選取 [基本 SAML 組態] 的鉛筆圖示，以編輯設定。

   

5. 在 [基本 SAML 組態] 區段上，執行下列步驟：

   a. 在 [識別碼] 文字方塊中，使用下列其中一種模式來輸入 URL：

   Identifier
   https://api.redocly.com/auth/sso?idpId=<CustomerId>
   https://api.<Region>.redocly.com/auth/sso?idpId=<CustomerId>

   b. 在 [回覆 URL] 文字方塊中，以下列其中一個模式輸入 URL：

   回覆 URL
   https://api.redocly.com/auth/sso
   https://api.<Region>.redocly.com/auth/sso
   https://<SiteName>.redoc.dev/_auth/saml2
   https://<SiteName>.<REGION>.redoc.dev/_auth/saml2

   c. 在 [登入 URL] 文字方塊中，以下列其中一個模式輸入 URL︰

   登入 URL
   https://app.redocly.com/login-sso
   https://app.<Region>.redocly.com/login-sso
   https://<SiteName>.redoc.dev/_auth/idp-login
   https://<SiteName>.<REGION>.redoc.dev/_auth/idp-login

   注意

   這些都不是真正的值。 請使用實際的「識別碼」、「回覆 URL」和「登入 URL」更新這些值。 請連絡 Redocly 支援小組 以取得這些值。 您也可以參考〈基本 SAML 組態〉一節中顯示的模式。

6. 在 [使用 SAML 設定單一登入] 頁面上的 [SAML 簽署憑證] 區段中，尋找 [憑證 (PEM)]，然後選取 [下載]，以下載憑證並將其儲存在您的電腦上。

   

7. 在 [設定 Redocly] 區段上，根據您的需求複製適當的 URL。

   

設定 Redocly SSO

若要在 Redocly 端設定單一登入，您必須將從應用程式組態下載的 憑證 (PEM) 和複製的適當 URL 傳送給 Redocly 支援小組。 此設定是為了正確設定雙方的 SAML SSO 連線。

建立 Redocly 測試使用者

本節會在 Redocly 中建立名為 B.Simon 的使用者。 Redocly 支援依預設啟用的 Just-In-Time 使用者佈建。 這一節沒有您需要進行的動作項目。 如果 Redocly 中還沒有任何使用者存在，在驗證之後通常會建立新的使用者。

測試 SSO

在本節中，您會使用下列選項來測試您的 Microsoft Entra 單一登入設定。

• 按一下 [測試此應用程式]，這樣會重新導向至 Redocly 登入 URL，您可以在其中起始登入流程。

• 直接前往 [重新登入 URL]，然後從該處起始登入流程。

• 您可以使用 Microsoft 我的應用程式。 當您在 [我的應用程式] 中按一下 [Redocly] 圖格時，這樣會重新導向至 [重新登入 URL]。 如需詳細資訊，請參閱 Microsoft Entra 我的應用程式。

其他資源

• 什麼是使用 Microsoft Entra ID 進行單一登入？
• 規劃單一登入部署。

下一步

設定 Redocly 後，您可以強制執行工作階段控制項，以即時防止組織的敏感性資料遭到外洩和滲透。 工作階段控制項會從條件式存取延伸。 了解如何使用 Microsoft Cloud App Security 來強制執行工作階段控制項。