Microsoft Entra SSO-Integration mit Redocly

In diesem Artikel erfahren Sie, wie Sie Redocly in Microsoft Entra ID integrieren. Redocly ist das erste Dokumentationstool für Entwickler, das es uns ermöglicht, die Dokumentationen in GitHub zu speichern, damit die Entwicklerdokumentation nah bei den Entwicklern verfügbar ist. Die Integration von Redocly mit Microsoft Entra ID ermöglicht Folgendes:

• Steuern Sie in Microsoft Entra ID, wer Zugriff auf Redocly hat.
• Sie können Ihren Benutzer*innen ermöglichen, sich mit ihren Microsoft Entra-Konten automatisch bei Redocly anzumelden.
• Verwalten Sie Ihre Konten an einem zentralen Ort.

Sie konfigurieren und testen das einmalige Anmelden von Microsoft Entra für Redocly in einer Testumgebung. Redocly unterstützt SP-initiiertes einmaliges Anmelden sowie die Just-In-Time-Benutzerbereitstellung.

Voraussetzungen

Um Microsoft Entra ID in Redocly zu integrieren, benötigen Sie Folgendes:

• Ein Microsoft Entra-Benutzerkonto. Falls Sie noch über keins verfügen, können Sie ein kostenloses Konto erstellen.
• Eine der folgenden Rollen: Anwendungsadministrator, Cloudanwendungsadministrator oder Anwendungsbesitzer.
• Ein Microsoft Entra-Abonnement. Falls Sie über kein Abonnement verfügen, können Sie ein kostenloses Azure-Konto verwenden.
• Redocly-Abonnement, für das einmaliges Anmelden (Single Sign-On, SSO) aktiviert ist.

Eine Anwendung hinzufügen und einen Testbenutzer zuweisen

Bevor Sie mit dem Konfigurationsprozess des einmaligen Anmeldens beginnen, müssen Sie die Redocly-Anwendung aus dem Microsoft Entra-Katalog hinzufügen. Sie müssen ein Testbenutzerkonto der Anwendung zuweisen und die Konfiguration der einmaligen Anmeldung testen.

Hinzufügen von Redocly aus dem Microsoft Entra-Katalog

Fügen Sie Redocly aus dem Microsoft Entra-Anwendungskatalog hinzu, um das einmalige Anmelden bei Redocly zu konfigurieren. Weitere Informationen zum Hinzufügen von Anwendungen aus dem Katalog finden Sie unter Schnellstart: Anwendungen aus dem Katalog hinzufügen.

Erstellen und Zuweisen eines Microsoft Entra-Testbenutzers

Folgen Sie den Richtlinien im Artikel Erstellen und Zuweisen eines Benutzerkontos, um ein Testbenutzerkonto namens B. Simon zu erstellen.

Alternativ können Sie auch den Enterprise App Configuration Wizard verwenden. In diesem Assistenten können Sie Ihrem Mandanten eine Anwendung hinzufügen, der App Benutzer/Gruppen hinzufügen und Rollen zuweisen. Der Assistent bietet auch einen Link zum Konfigurationsbereich für einmaliges Anmelden. Erfahren Sie mehr über Microsoft 365-Assistenten.

Konfigurieren des einmaligen Anmeldens (SSO) von Microsoft Entra

Führen Sie die folgenden Schritte aus, um das einmalige Anmelden (SSO) von Microsoft Entra zu aktivieren.

1. Melden Sie sich beim Microsoft Entra Admin Center mindestens als Cloudanwendungsadministrator an.

2. Navigieren Sie zu Identität>Anwendungen>Unternehmensanwendungen>Redocly>Einmaliges Anmelden.

3. Wählen Sie auf der Seite SSO-Methode auswählen die Methode SAML aus.

4. Wählen Sie auf der Seite Einmaliges Anmelden (SSO) mit SAML einrichten das Stiftsymbol für Grundlegende SAML-Konfiguration aus, um die Einstellungen zu bearbeiten.

   

5. Führen Sie im Abschnitt Grundlegende SAML-Konfiguration die folgenden Schritte aus:

   a. Geben Sie im Textfeld Bezeichner eine URL in einem der folgenden Formate ein:

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

   b. Geben Sie im Textfeld Antwort-URL eine URL in einem der folgenden Formate ein:

   Antwort-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. Geben Sie im Textfeld Anmelde-URL eine URL in einem der folgenden Formate ein:

   Anmelde-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

   Hinweis

   Hierbei handelt es sich um Beispielwerte. Ersetzen Sie diese Werte durch die tatsächlichen Werte für Bezeichner, Antwort-URL und Anmelde-URL. Diese Werte erhalten Sie vom Redocly-Supportteam. Sie können sich auch die Muster im Abschnitt Grundlegende SAML-Konfiguration ansehen.

6. Suchen Sie auf der Seite Einmaliges Anmelden (SSO) mit SAML einrichten im Abschnitt SAML-SignaturzertifikatZertifikat (PEM) und wählen Sie Herunterladen aus, um das Zertifikat herunterzuladen, und speichern Sie es auf Ihrem Computer.

   

7. Kopieren Sie im Abschnitt Redocly einrichten die entsprechenden URLs gemäß Ihren Anforderungen.

   

Konfigurieren des einmaligen Anmeldens für Redocly

Zum Konfigurieren des einmaligen Anmeldens aufseiten von Redocly müssen Sie das heruntergeladene Zertifikat (PEM) und die entsprechenden kopierten URLs aus der Anwendungskonfiguration an das Supportteam von Redocly senden. Es führt die Einrichtung durch, damit die SAML-SSO-Verbindung auf beiden Seiten richtig festgelegt ist.

Erstellen eines Redocly-Testbenutzers

In diesem Abschnitt wird in Redocly ein Benutzer namens B. Simon erstellt. Redocly unterstützt die Just-in-Time-Benutzerbereitstellung, die standardmäßig aktiviert ist. Für Sie steht in diesem Abschnitt kein Aktionselement zur Verfügung. Wenn ein Benutzer in Redocly noch nicht vorhanden ist, wird nach der Authentifizierung in der Regel ein neuer Benutzer erstellt.

Testen des einmaligen Anmeldens

In diesem Abschnitt testen Sie die Microsoft Entra-Konfiguration für einmaliges Anmelden mit den folgenden Optionen.

• Klicken Sie auf Diese Anwendung testen. Dadurch werden Sie zur Anmelde-URL von Redocly weitergeleitet, wo Sie den Anmeldeflow initiieren können.

• Rufen Sie direkt die Anmelde-URL für Redocly auf, und initiieren Sie dort den Anmeldeflow.

• Sie können „Meine Apps“ von Microsoft verwenden. Wenn Sie im Bereich „Meine Apps“ auf die Kachel „Redocly“ klicken, werden Sie zur Anmelde-URL von Redocly weitergeleitet. Weitere Informationen finden Sie unter „Meine Apps“ in Microsoft Entra.

Zusätzliche Ressourcen

• Was ist einmaliges Anmelden mit Microsoft Entra ID?
• Planen einer Bereitstellung für einmaliges Anmelden.

Nächste Schritte

Nach dem Konfigurieren von Redocly können Sie die Sitzungssteuerung erzwingen, die in Echtzeit vor der Exfiltration und Infiltration vertraulicher Unternehmensdaten schützt. Die Sitzungssteuerung basiert auf bedingtem Zugriff. Hier erfahren Sie, wie Sie die Sitzungssteuerung mit Microsoft Cloud App Security erzwingen.