Skip to main content

Configure SSO with Microsoft Entra ID

availability
Platform:WebMobile
Plan Type:BasicEssentialPremiumEnterprise
User Type:RequesterFull UserAdministrator

This article explains how to set up single sign-on (SSO) for MaintainX using Microsoft Entra ID as the identity provider (IdP).

Requirements​

  • A MaintainX Enterprise account.
  • An Administrator user profile with access to the MaintainX organizations you want to set up SSO for.
  • Access to the Microsoft Entra ID admin center with the privileges needed to set up SSO.

Get Your MaintainX Configuration Information​

  1. Log into MaintainX as an Administrator.

  2. From the sidebar, open the Settings menu and select Customizations.

  3. On the Customizations tab, go to Single Sign-On (SSO) Self-Serve and select Set SSO Preferences.

    • If MaintainX doesn't have IdP information for your organization, the Register Identity Provider dialog opens.​

      Select Create to generate your IdP information and open the Single Sign-On Configuration dialog.​

    • If MaintainX does have IdP information for your organization, the Single Sign-On Configuration dialog opens right away.​

tip

Leave the Single Sign-On Configuration dialog open. During the configuration, you will need to copy some values from Entra ID into MaintainX and copy some values from MaintainX into the Entra ID admin center.

Create an Application in Microsoft​

  1. Log into the Microsoft Entra ID admin center.

  2. From the sidebar, select Identity > Applications > Enterprise applications.

  3. In the Enterprise applications pane, select + New application.

  4. Select + Create your own application. A dialog box opens.

  5. In the dialog box, do the following:

    • Set the name of your application. We recommend you set it to MaintainX.
    • Select Integrate any other application you don't find in the gallery.
    • Select Create.

The Entra ID admin center displays the settings and details for your new application.

Copy Your SSO URLs from MaintainX to Entra ID​

In MaintainX:

  1. Open the Single Sign-On Configuration dialog.

  2. Locate the URLs in the following fields. You will need to copy them into the Entra ID admin center console:

    • Entity ID (Audience URI)
    • ACS URL
    • Start URL

In the Entra ID admin center:

  1. In your application settings sidebar, navigate to the Manage section and select Single sign-on. The Single sign-on pane opens.

  2. Select SAML as the single sign-on method. The SSO configuration page opens.

  3. Go to the Basic SAML Configuration section and select Edit.

  4. In the Basic SAML Configuration options, enter the URLs from the MaintainX Single Sign-On Configuration in the correct fields:

    Copy this MaintainX URLInto these fields in Entra ID
    Entity ID (Audience URI)
    Starts with: https://www.okta.com/saml2/service-provider/
    Identifier (Entity ID)
    ACS URL
    Starts with: https://maintainx.okta.com/sso/saml2/
    Reply URL (Assertion Consume Service URL)
    Start URL
    Starts with: https://app.getmaintainx.com/auth/login/saml/
    Sign on URL (Optional)

    Relay State (Optional)
  5. Select Save.

Configure the Additional Claims in Microsoft Entra ID​

warning

You must configure the additional claims or the SSO setup won't work as expected.

In the Entra ID admin center:

  1. On the SSO configuration page, go to the Attributes & Claims section and select Edit.

  2. On the Attributes & Claims page, go to the Additional Claims section.

  3. For each claim that you need to edit, do the following:

    1. Select the claim. The Manage Claim screen opens.

    2. In the Name field, enter the name in the following table.

      For the claim with this ValueChange the Name to
      user.mail
      or
      user.principalname
      (Depending on your Entra ID setup)
      email
      user.givennamefirstName
      user.surnamelastName
    3. If the Namespace field contains a URL, delete it.

      info

      Entra ID uses the following format for default namespaces: http://schemas.microsoft.com/identity/claims/extn.<attributename>.

    4. Select Save.

The Attributes & Claims section should look something like this:

Correct Claims section in Entra ID
Correct Claims section in Entra ID

Download Your SAML Signing Certificate​

You need a SAML signing certificate to make Entra ID an identity provider in MaintainX.

In the Entra ID admin center:

  1. On the SSO configuration page, navigate to SAML Certificates section.
  2. Locate the Download link for Certificate (Base64).
  3. Download the certificate to your computer.

Upload Your SAML Signing Certificate to MaintainX​

In MaintainX:

  1. Open the Single Sign-On Configuration dialog.
  2. Navigate to the Identity Provider Configuration section.
  3. Select Certificate > Upload.
  4. Select the certificate you downloaded from Entra ID earlier, and submit it.

Copy Your IdP Configuration Settings From Entra ID to MaintainX​

In the Entra ID admin center:

  1. On the SSO configuration page, navigate to the Set up <APPLICATION NAME> section.

  2. Locate the URLs in the following fields. You will need to copy them into MaintainX:

    • Login URL
    • Microsoft Entra ID Identifier

In MaintainX:

  1. Open the Single Sign-On Configuration dialog.

  2. Navigate to the Identity Provider Configuration settings section:

  3. Enter the following values from the Entra ID admin console:

    Copy this value from Entra IDTo these fields in MaintainX
    Login URL
    Starts with: https://login.microsoftonline.com/​
    Single Sign On (SSO) URL
    or
    Destination
    Microsoft Entra Identifier
    Starts with: https://sts.windows.net/
    Issuer URI
  4. Select Update.

Test the SSO Configuration in Entra ID​

In the Entra ID admin center:

  1. On the SSO configuration page, navigate to the Test single sign-on with <APPLICATION NAME> section.
  2. Select Test.
  3. When Entra ID prompts you, log in to your application.

Next Steps​

After you configure SSO, there are a few more things you need to do to finish the setup.

  • Test your SSO setup in MaintainX.
  • Map your domains.
  • Set the default account type for new users.
  • Migrate your existing users to SSO.
  • Enable SSO for your other MaintainX organizations.

For more information, see Set Up SSO.