Edit

Microsoft Entra SSO integration with Redocly

  • Article

In this article, you'll learn how to integrate Redocly with Microsoft Entra ID. Redocly is the first developer documentation tool that allows us to keep the docs in GitHub, keeping developer docs close to the developers. When you integrate Redocly with Microsoft Entra ID, you can:

  • Control in Microsoft Entra ID who has access to Redocly.
  • Enable your users to be automatically signed-in to Redocly with their Microsoft Entra accounts.
  • Manage your accounts in one central location.

You'll configure and test Microsoft Entra single sign-on for Redocly in a test environment. Redocly supports SP initiated single sign-on and Just In Time user provisioning.

Prerequisites

To integrate Microsoft Entra ID with Redocly, you need:

  • A Microsoft Entra user account. If you don't already have one, you can Create an account for free.
  • One of the following roles: Global Administrator, Cloud Application Administrator, Application Administrator, or owner of the service principal.
  • A Microsoft Entra subscription. If you don't have a subscription, you can get a free account.
  • Redocly single sign-on (SSO) enabled subscription.

Add application and assign a test user

Before you begin the process of configuring single sign-on, you need to add the Redocly application from the Microsoft Entra gallery. You need a test user account to assign to the application and test the single sign-on configuration.

Add Redocly from the Microsoft Entra application gallery to configure single sign-on with Redocly. For more information on how to add application from the gallery, see the Quickstart: Add application from the gallery.

Create and assign Microsoft Entra test user

Follow the guidelines in the create and assign a user account article to create a test user account called B.Simon.

Alternatively, you can also use the Enterprise App Configuration Wizard. In this wizard, you can add an application to your tenant, add users/groups to the app, and assign roles. The wizard also provides a link to the single sign-on configuration pane. Learn more about Microsoft 365 wizards..

Configure Microsoft Entra SSO

Complete the following steps to enable Microsoft Entra single sign-on.

  1. Sign in to the Microsoft Entra admin center as at least a Cloud Application Administrator.

  2. Browse to Identity > Applications > Enterprise applications > Redocly > Single sign-on.

  3. On the Select a single sign-on method page, select SAML.

  4. On the Set up single sign-on with SAML page, select the pencil icon for Basic SAML Configuration to edit the settings.

    Screenshot shows how to edit Basic SAML Configuration.

  5. On the Basic SAML Configuration section, perform the following steps:

    a. In the Identifier textbox, type a URL using one of the following patterns:

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

    b. In the Reply URL textbox, type a URL using one of the following patterns:

    Reply 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. In the Sign on URL textbox, type a URL using one of the following patterns:

    Sign on 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

    Note

    These values are not real. Update these values with the actual Identifier, Reply URL and Sign on URL. Contact Redocly support team to get these values. You can also refer to the patterns shown in the Basic SAML Configuration section.

  6. On the Set-up single sign-on with SAML page, in the SAML Signing Certificate section, find Certificate (PEM) and select Download to download the certificate and save it on your computer.

    Screenshot shows the Certificate download link.

  7. On the Set up Redocly section, copy the appropriate URL(s) based on your requirement.

    Screenshot shows to copy configuration appropriate URL.

Configure Redocly SSO

To configure single sign-on on Redocly side, you need to send the downloaded Certificate (PEM) and appropriate copied URLs from the application configuration to Redocly support team. They set this setting to have the SAML SSO connection set properly on both sides.

Create Redocly test user

In this section, a user called B.Simon is created in Redocly. Redocly supports just-in-time user provisioning, which is enabled by default. There's no action item for you in this section. If a user doesn't already exist in Redocly, a new one is commonly created after authentication.

Test SSO

In this section, you test your Microsoft Entra single sign-on configuration with following options.

  • Click on Test this application, this will redirect to Redocly Sign-on URL where you can initiate the login flow.

  • Go to Redocly Sign-on URL directly and initiate the login flow from there.

  • You can use Microsoft My Apps. When you click the Redocly tile in the My Apps, this will redirect to Redocly Sign-on URL. For more information, see Microsoft Entra My Apps.

Additional resources

Next steps

Once you configure Redocly you can enforce session control, which protects exfiltration and infiltration of your organization’s sensitive data in real time. Session control extends from Conditional Access. Learn how to enforce session control with Microsoft Cloud App Security.