Skip to main content

Migrate Existing MaintainX Users to SSO

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

If a MaintainX organization already has users when you set up single sign-on (SSO), you have to update the existing user accounts to use SSO.

You can migrate users to SSO in the following ways:

Use the Start URL​

Users you created before you enabled SSO can follow the organization's Start URL to switch to SSO authentication. When a non-SSO user follows the Start URL, they're prompted to log in with their SSO credentials. After a user logs in with SSO for the first time, MaintainX updates their authentication method.

warning

Users must log out of MaintainX before following the Start URL. Otherwise they won't be directed to the SSO login.

To migrate users via the Start URL:

  1. Log in as an Administrator to the MaintainX organization whose users you want to migrate SSO.

  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.

    The Single Sign-On Configuration dialog opens.

  4. Navigate to the Start URL.

  5. Select Copy URL.

  6. Send the Start URL to the users you want to migrate, along with instructions to log out of MaintainX, and then follow the Start URL.

Use the MaintainX REST API​

To change a user's authentication method to SSO using the MaintainX REST API, use the following endpoint:

PATCH https://api.getmaintainx.com/v1/users/{id}

In the request body, make sure to include:

"authtype": "SAML",
note

After the update, users have to log out of MaintainX and log in again to authenticate using SSO.

For more information, see Update user information in the MaintainX REST API documentation.

Contact Support​

MaintainX Customer Support can help you migrate all your non-SSO users to SSO authentication.

note

Bulk-migrating users to SSO logs all the affected users out of MaintainX so they can log back in using SSO.