Before starting the integration process, you must have requested, and been approved for, an Onshape Enterprise account or trial, and have an Onshape Enterprise domain name.

An example of an Enterprise domain name might be: MyCompanyName.onshape.com.

Note that you are only able to use one SSO provider at a time.

This configuration process might fail without parameter values customized for your organization. Use your custom SSO identity provider (for example: Okta, PingOne, or ClassLink) dashboard to add Onshape as an application and record the values that are specific for your organization. You need those values for the following procedure.

Onshape signs all outgoing SAML certification requests. You are not required to upload any certificates (for example, a SAML signing certificate), except in the case of ADFS integration because ADFS validates incoming SAML requests. Note that Microsoft also recommends migration from the latest version of ADFS to Microsoft Entra ID. See ADFS Overview for more information.

Typically, an SSO provider is set up for one Enterprise. If setting up a multi-tenant configuration (an SSO provider with multiple Enterprises) using SAML 2.0, the Administrator must use com.onshape.saml2.sp.<domain prefix> as the Onshape Entity ID, and check the Use entityid with company domain prefix box. See the "Configuring the SSO provider in Onshape" section below.

Each Identity provider (IdP) has its own proprietary setup procedure. Consult your identity provider's single sign-on setup instructions for the exact procedure to follow. The instructions in this section are meant to be used as general guidelines only.

Onshape only supports the SAML HTTP-POST binding.

Onshape does not have a way to express its SAML configuration as a metadata XML file.

In your Identity provider console, create a new trust relationship (sometimes called a "relying party") with the following configuration:

  1. Assertion consumer service (ACS) URL: https://cad.onshape.com/identity/saml2/sso. If integrating with a Government Enterprise, use https://cad.usgov.onshape.com/identity/saml2/sso instead.

  2. Entity ID: com.onshape.saml2.sp.

  3. The assertion subject's NameId value. This is the email address of the user to whom the SAML assertion corresponds.

  4. The three SAML assertion attributes required by Onshape (sometimes called "claims"):

    • firstName - The assertion subject's given name

    • lastName - The assertion subject's family name.

    • companyName - The assertion subject's company. In most cases the company name is the same as the domain prefix of your enterprise. For example, if your Onshape enterprise name is fishbowl.onshape.com, enter fishbowl into this field.

  5. Locate and copy the SAML IdP Metadata XML file to your clipboard. You will need this later in the process.

  6. Make the new trust relationship available to all users to whom you want to provide Onshape SSO access.

Once Onshape is configured in the identity provider and you have downloaded the identity provider's metadata file (referred to in Onshape as the configuration file), the SSO provider can be configured in Onshape.

The example images below shows a generic identity provider being configured, but the steps are the same for all identity providers.

  1. Sign in to your Onshape Enterprise account, using your specialized domain name, as an administrator. Select Enterprise settings from your account:

    Going into My Account menu and clicking the Enterprise settings button

  2. Select Authentication from the left navigation menu.

  3. In the Single sign-on (SSO) subsection, click the Configure SSO provider button:

    Clicking the Configure SSO provider under the Single sign on (SSO) settings

  4. The Create SSO provider dialog opens:

    Create SSO Provider dialog

    1. In the Name field, enter name, such as Custom SSO

    2. In the Provider type dropdown, select your SSO provider from the list.

    3. Leave Enable SSO provider checked.

    4. Leave Disable Onshape password sign in unchecked for the moment.

      5. Disable Onshape password sign in disables the typical Onshape password sign in for you and your users. Only the SSO provider sign in prompt is displayed for the Onshape URL. Before checking this option, ensure you can sign in to Onshape yourself (as administrator). You can return here later and enable it once sign in through your SSO provider is verified to work correctly.

      Choosing to enforce signing in to Onshape via SSO also results in users not being able to sign in to non-enterprise domains directly, such as cad.onshape.com.

    5. Check Use entityid with company domain prefix if you have a multi-tenant setup (an SSO provider with multiple Enterprises).

      6. Typically, an SSO provider is set up for one Enterprise. If setting up a multi-tenant configuration (an SSO provider with multiple Enterprises) using SAML 2.0, the Administrator must use com.onshape.saml2.sp.<domain prefix> as the Onshape Entity ID, and check the Use entityid with company domain prefix box.

    6. Click the Upload configuration file button:

  5. Locate and select the metadata configuration file you downloaded previously, and click Open:

    Opening the previously downloaded XLM metadata file

  6. Click OK:

    Finalizing the creation of the SSO Provider by clicking OK

  7. The file is uploaded. A notification appears when the upload is completed:

    Notification showing the SSO Configuration file was successfully uploaded

  8. Sign out of both your Onshape and SSO provider accounts. Be sure to do a hard refresh of both accounts. When you reach the Onshape sign-in page once again, the page has a new Sign in link at the bottom, for your SSO provider.

    Onshape Sign-in screen

In order to sign in to Onshape, administrators must provision their users (in their single sign on account) to use the Onshape application.