Set up SAML SSO with Microsoft Entra ID (formerly Azure AD)

This guide walks through configuring Microsoft Entra ID (formerly known as Azure Active Directory) as your GraphOS organization's identity provider (IdP) for SAML-based SSO.

Prerequisites

Setup requires:

• A GraphOS user account with the Org Admin role

  • Check the Members tab in GraphOS Studio to see your role and which team members are org admins

• Administrative access to your IdP

Setup

SAML-based SSO setup has these steps:

1. Enter your SSO details in GraphOS Studio.
2. Create a custom Entra ID enterprise application for GraphOS.
3. Share your Entra ID enterprise application's SAML metadata in GraphOS Studio.
4. Verify and configure OIDC details.
5. Verify your SSO configuration works.
6. Enable SSO in GraphOS Studio.

The SSO setup wizard in GraphOS Studio guides you through these steps.

Step 1. Enter your SSO details

1. Go to GraphOS Studio. Open the Settings page from the top navigation. Open the Security tab from the left sidebar and click Migrate SSO. A setup wizard appears.
2. Enter the Email domain(s) you are setting SSO up for. Click Continue.
3. Select SAML as the SSO type. Click Continue.

Step 2. Create an Entra ID enterprise application

1. Once you reach Step 2: Configure Your IdP in the wizard, go to your Microsoft Entra admin center. Alternatively, you can sign in to the Azure Portal and then go to Microsoft Entra ID.

2. Go to Identity > Applications > Enterprise applications and select +New application in the top menu.

3. In the top menu, select +Create your own application.

4. Enter Apollo GraphOS as the name of your app. Below, keep the Integrate any other application you don't find in the gallery (Non-gallery) option selected. Click Create.

   

5. On the app's Overview page, select 2. Set up single sign-on. You'll assign users and groups later.

6. On the app's Single sign-on page, select SAML as the single sign-on method.

7. At the top of the SAML-based Sign-on page, click Upload metadata file and upload the file provided by the GraphOS setup wizard. Alternatively, you can enter these values manually in the Basic SAML Configuration section:

   • Identifier (Entity ID): Entity ID value provided by the setup wizard

   • Reply URL (Assertion Consumer Service URL): Single Sign-on URL provided by the setup wizard

   Click Save.

8. In Attributes & Claims, ensure the following claim names have the corresponding source attributes:

   • email: user.mail

   • given_name: user.givenname

   • family_name: user.surname

   • sub: user.userprinicipalname

   • Unique User Identifier: user.userprinicipalname

   Otherwise, manually enter them.

   

   Leave Namespace blank for each claim.

   

9. Under SAML Certificates, copy the App Federation Metadata URL into a text file for the next step.

1. In the setup wizard in GraphOS Studio, select whether your Entra implementation requires signing an AuthnRequest.

2. Click Next.

Step 3. Share SAML metadata with Apollo

In the setup wizard, enter the App Federation Metadata URL you previously copied into the Upload metadata from URL field. Click Next.

Step 4. Verify details

The GraphOS Studio setup wizard populates your SSO metadata based on the URL you entered in the last step. Verify the values are correct.

You can find them in Entra ID, Identity > Applications > Enterprise applications, in the application you created for GraphOS.

• Your application's Entity ID is in the Single sign-on tab. Scroll down to the Basic SAML Configuration section and look for a field labeled Identifier (Entity ID). This field contains the Entity ID. It has the following format: urn:<unique>.<region>.auth0.com.

• The SSO URL is also in thee Basic SAML Configuration section in the Sign on URL field.

Once you've verified the values or corrected them, click Next.

Step 5. Verify SSO Configuration

To verify that your SSO configuration works, click Login with new SSO in the GraphOS Studio wizard. This button launches a new login session in a new browser tab. Once you successfully login using your new configuration, click Next.

Step 6. Enable SSO

Once you've verified your new SSO configuration works, you'll be prompted to finalize your configuration.

If team members could previously login before you implemented SSO, they must re-login to GraphOS Studio via SSO. Signing in creates a new user profile for them. Any personal API keys associated with their previous user profile will be lost. (Graph API keys are unaffected and remain functional.) Additionally, you must reassign any GraphOS roles associated with their previous user profile.

Set default GraphOS role

Once you've enabled SSO, you can optionally set the default GraphOS role for new users logging in via SSO. If you don't set a default, the default role is Consumer. To update the default role for new SSO users, go to Settings > Security > Single sign-on and click Update new user role. Org admins can always update other users' roles.

Assign users in Entra ID

Once you've set up your Apollo GraphOS application in Entra ID, you need to assign users to it so they can access GraphOS. You can assign individual users or groups from the User and groups page of your Apollo GraphOS application in Entra ID.

You may want to begin by adding yourself individually and then testing SSO by clicking Test at the bottom of the Single sign-on page. Once you've successfully tested your own user's ability to use SSO, add any applicable users or groups.

Once you've verified your new SSO configuration works, you'll be prompted to finalize your configuration.

If team members could previously login before you implemented SSO, they must re-login to GraphOS Studio via SSO. Signing in creates a new user profile for them. Any personal API keys associated with their previous user profile will be lost. (Graph API keys are unaffected and remain functional.) Additionally, you must reassign any GraphOS roles associated with their previous user profile.

Once you've confirmed the new configuration works for your users, remove any legacy Apollo GraphOS applications in Entra ID or app registrations in Azure AD if you have them.