Delen via

Redocly configureren voor eenmalige aanmelding met Microsoft Entra-id

In dit artikel leert u hoe u Redocly integreert met Microsoft Entra ID. Redocly is het eerste hulpprogramma voor ontwikkelaarsdocumentatie waarmee we de documenten in GitHub kunnen bewaren, zodat ontwikkelaarsdocumenten dicht bij de ontwikkelaars blijven. Wanneer u Redocly integreert met Microsoft Entra ID, kunt u het volgende doen:

  • In Microsoft Entra ID beheren wie toegang heeft tot Redocly.
  • Ervoor zorgen dat gebruikers automatisch met hun Microsoft Entra-account worden aangemeld bij Redocly.
  • Beheer uw accounts op één centrale locatie.

U configureert en test eenmalige aanmelding van Microsoft Entra voor Redocly in een testomgeving. Redocly ondersteunt door SP geïnitieerde eenmalige aanmelding en Just In Time-inrichting van gebruikers.

Vereiste voorwaarden

Als u Microsoft Entra ID wilt integreren met Redocly, hebt u het volgende nodig:

Toepassing toevoegen en een testgebruiker toewijzen

Voordat u begint met het configureren van eenmalige aanmelding, moet u de Redocly-toepassing toevoegen vanuit de Microsoft Entra-galerie. U hebt een testgebruikersaccount nodig om toe te wijzen aan de toepassing en de configuratie voor eenmalige aanmelding te testen.

Voeg Redocly toe vanuit de Microsoft Entra-toepassingsgalerie om eenmalige aanmelding met Redocly te configureren. Zie de Quickstart: Toepassing toevoegen vanuit de galerievoor meer informatie over het toevoegen van toepassingen vanuit de galerie.

Microsoft Entra-testgebruiker maken en toewijzen

Volg de richtlijnen in het artikel voor het maken en toewijzen van een gebruikersaccount om een testgebruikersaccount met de naam B.Simon te maken.

Als alternatief kunt u ook gebruikmaken van de Enterprise App Configuration Wizard. In deze wizard kunt u een toepassing toevoegen aan uw tenant, gebruikers/groepen toevoegen aan de app en rollen toewijzen. De wizard biedt ook een koppeling naar het configuratievenster voor eenmalige aanmelding. Meer informatie over Microsoft 365-wizards.

De SSO van Microsoft Entra configureren

Voer de volgende stappen uit om eenmalige aanmelding van Microsoft Entra in te schakelen.

  1. Meld u aan bij het Microsoft Entra-beheercentrum als ten minste een cloudtoepassingsbeheerder.

  2. Blader naar Entra ID>Enterprise-apps>Redocly>Eenmalige aanmelding.

  3. Selecteer op de pagina Selecteer een methode voor eenmalige aanmelding de optie SAML.

  4. Selecteer op de pagina Eenmalige aanmelding instellen met SAML het potloodpictogram voor Standaard-SAML-configuratie om de instellingen te bewerken.

    Schermopname laat zien hoe u Standaard SAML-configuratie kunt bewerken.

  5. In de sectie Standaard SAML-configuratie voert u de volgende stappen uit:

    een. In het tekstvak Identifier typt u een URL met een van de volgende patronen:

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

    b. In het tekstvak Antwoord-URL typt u een URL volgens een van de volgende patronen:

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

    Hoofdstuk c. Typ in het tekstvak Aanmeldings-URL een URL met een van de volgende patronen:

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

    Notitie

    Deze waarden zijn niet echt. Werk deze waarden bij met de werkelijke id, antwoord-URL en aanmeldings-URL. Neem contact op met het ondersteuningsteam van Redocly om deze waarden te verkrijgen. U kunt ook verwijzen naar de patronen die worden weergegeven in de sectie Standaard SAML-configuratie.

  6. Zoek op de pagina Eenmalige aanmelding instellen met SAML in de sectie SAML-handtekeningcertificaathet certificaat (PEM) en selecteer Downloaden om het certificaat te downloaden en op uw computer op te slaan.

    Schermopname toont de downloadkoppeling voor het certificaat.

  7. In de sectie Redocly instellen kopieert u de juiste URL('s) op basis van uw behoeften.

    De schermafbeelding toont hoe de juiste URL voor de configuratie kan worden gekopieerd.

Redocly SSO configureren

Als u eenmalige aanmelding aan de zijde van Redocly wilt configureren, moet u het gedownloade certificaat (PEM) en de juiste uit de toepassingsconfiguratie gekopieerde URL's verzenden naar het ondersteuningsteam van Redocly. Ze hebben deze instelling aangepast om ervoor te zorgen dat de SAML SSO-verbinding aan beide zijden correct is ingesteld.

Testgebruiker voor Redocly maken

In deze sectie wordt een gebruiker met de naam B.Simon gemaakt in Redocly. Redocly biedt ondersteuning voor Just-In-Time-inrichting van gebruikers. Deze functie is standaard ingeschakeld. Deze sectie bevat geen actie-item voor u. Als er nog geen gebruiker in Redocly bestaat, wordt er meestal een nieuwe gemaakt na verificatie.

Testen van Single Sign-On (SSO)

In deze sectie test u de configuratie voor eenmalige aanmelding van Microsoft Entra met de volgende opties.

  • Selecteer Deze toepassing testen. Met deze optie wordt u omgeleid naar de aanmeldings-URL van Redocly, waar u de aanmeldingsstroom kunt initiëren.

  • Ga rechtstreeks naar de aanmeldings-URL van Redocly en initieer de aanmeldingsstroom daar.

  • U kunt Microsoft Mijn apps gebruiken. Wanneer u de tegel Redocly selecteert in Mijn apps, wordt deze optie omgeleid naar de aanmeldings-URL van Redocly. Zie Microsoft Entra Mijn apps voor meer informatie.

Aanvullende bronnen

Verwante inhoud

Zodra u Redocly hebt geconfigureerd, kunt u sessiebeheer afdwingen, waardoor exfiltratie en infiltratie van gevoelige gegevens van uw organisatie in realtime worden beschermd. Sessiebeheer is een uitbreiding van voorwaardelijke toegang. Meer informatie over het afdwingen van sessiebeheer met Microsoft Cloud App Security.

  • Last updated on