Configure Microsoft Entra ID

:::tip[]
SSO is available on Apidog Enterprise plan.
:::

To configure SSO with Microsoft Entra ID (formerly Azure Active Directory) for your organization, you must have administrator access for both Microsoft Entra ID and Apidog.

Preparation

Before configuring in the Microsoft Entra ID dashboard, please visit the SAML SSO page in the organization settings of Apidog, then turn on the "Require SAML Authentication" switch, and keep this page open.

Configuration of Microsoft Entra ID

Before configuring in the Microsoft Entra ID dashboard, please visit the SAML SSO page in the organization settings of Apidog, then turn on the "Require SAML Authentication" switch, and keep this page open.

To configure your SAML application, do the following:

• Open your Microsoft Entra ID management portal in a browser.

• Go to Enterprise applications and select New application.

• Click Create your own application, enter the name of the application such as "Apidog", and then select "Integrate any other application you don't find in the gallery (Non-gallery)."

• On the application's Overview page, Click Set up single sign on, and select SAML as the single sign-on method.

• Copy the Identifier in Apidog, and paste it to the Identifier (Entity ID) of Basic SAML Configuration in Microsoft Entra ID.

• Copy the Assertion consumer service URL in Apidog, and paste it to the Reply URL (Assertion Consumer Service URL) of Basic SAML Configuration in Microsoft Entra ID.

• Download the Certificate (Base64) of SAML Certificates in Microsoft Entra ID, open it with a code editor such as Visual Studio Code, copy the text in file, and paste it to the Public Certificate in Apidog.

• Copy the Login URL in Microsoft Entra ID, and paste it to the IdP Sign on URL field in Apidog.

• Copy the Microsoft Entra Identifier in Microsoft Entra ID, and paste it to the Issuer field in Apidog.

• To support identity provisioning, you should set the Unique User Identifier (Name identifier) claim in Microsoft Entra ID as follows:

  • Name identifier format to Persistent.

  • Source attribute to user.objectid.

• Save these configurations in both Microsoft Entra ID and Apidog.

Test your SAML configuration

You can now return to Apidog's homepage, select your organization from the sidebar, and click the entrance for SSO login on the right. Please test if you can log in normally.