Setting Up SSO

Enterprise Plans only

caution

If you have previously implemented the deprecated SSO integration and wish to migrate to the new SSO implementation, follow our step-by-step migration tutorial.

Sauce Labs supports Identity Provider (IdP)-initiated and Service Provider (SP)-initiated Single Sign-On (SSO) via SAML 2.0 protocol. This feature allows your authorized employees to access Sauce Labs in a moderated fashion, as an alternative to using credentials. SAML SSO is available to invoiced accounts, and can only be implemented by the organization admin of the account. If you are an invoice customer, the following sections will guide you on how to set up SAML SSO.

Sauce Labs supports the following features:

• SP-initiated SSO.
• IdP-initiated SSO.
• JIT (Just-In-Time) Provisioning.
• Force authentication.

What You'll Need

• An enterprise license for Sauce Labs.
• Organization admin access (see User Roles for more information).

Special Cases

• If your company has more than one organization at Sauce Labs to be integrated with SAML SSO and your Identity Provider requires a unique entity ID for Service Providers, see these special setup steps.
• If your company has multiple organizations at Sauce Labs to be integrated with SAML SSO, and you want to use the same email domain across multiple organizations, please refer to this section.

Setup Overview

First, set up a new SAML application in your Identity Provider (IdP). Next, enable and configure SSO in Sauce Labs Team Management Panel.

note

SSO at Sauce Labs is global. In other words, it does not matter in which region you set it up. Unlike to the former SSO implementation, which has been deprecated.

Setting Up Identity Provider

tip

We provide preconfigured SAML applications for some identity providers. They allow you to set up SSO integration with a few clicks. Choose your provider and follow the configuration steps:

• Auth0
• Google
• Microsoft Azure Active Directory
• Okta
• OneLogin
• PingOne

If you use a custom identity provider or your provider does not appear in the list above, please complete the manual setup:

1. Obtain SAML metadata from Sauce Labs Service Provider, which is served under this link.
2. Log in to your identity provider administrator panel.
   • For example in Okta, you log into your account and click the Admin button.
3. Create a new SAML application.
   • In the IdP, go to the "Applications" or "Integrations" section and create a new SAML application.
   • Follow the instructions from your IdP to provide the Sauce Labs SAML metadata obtained in Step 1. If your IdP does not allow uploading service provider metadata, set up the integration manually using Service Provider SAML Requirements.
4. Export SAML metadata of your new SAML application.
   • It will be used to set up the SSO at Sauce Labs in Team Management Panel.

Service Provider SAML Requirements

Here is the list of settings that are required by Sauce Labs Service Provider:

Setting	Value
Entity ID	https://accounts.saucelabs.com/sp
Audience URI	https://accounts.saucelabs.com/sp
Assertion Consumer Service	https://accounts.saucelabs.com/am/AuthConsumer/metaAlias/authtree/sp
Recipient URL	https://accounts.saucelabs.com/am/AuthConsumer/metaAlias/authtree/sp
Destination URL	https://accounts.saucelabs.com/am/AuthConsumer/metaAlias/authtree/sp
Name ID format	urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress
Binding	urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST

Signature

Either the SAML Assertion or SAML Response must be signed.

A digital signature is required to ensure that only your IdP generated the assertion.

Encryption

Encryption of the SAML Assertion is not mandatory.

You can enable encryption if you want an additional layer of security. You will need to use the certificate (with alias encryption) from the Sauce Labs metadata.

tip

Possible Issues

If you start to see errors after enabling encryption, make sure that you use the encryption certificate that is provided in Sauce Labs metadata (in the tag <KeyDescriptor use="encryption">) and the encryption algorithm matches the algorithm provided in Sauce Labs metadata (value of the attribute Algorithm in the tag EncryptionMethod).

Name ID

Name ID format must be set to urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress.

The value of the attribute NameID in SAML Response must be a valid email address. We do not accept values which are not email addresses, for instance usernames, IDs, etc.

SAML Claims

Sauce Labs Service Provider supports the following SAML custom claims:

• first_name
• last_name

Incorporating these attributes can improve user identification and personalization within the Sauce Labs platform. These attributes are optional.

Identity Provider Certificate Rotation

SAML certificates have a predetermined expiration date. It is possible that your identity provider will notify you in advance or provide an alert regarding the certificate's expiry.

If the certificate for the Sauce Labs app from your identity provider is nearing expiration or has already expired, follow these steps:

1. Generate a new certificate for the Sauce Labs app within your identity provider. This new certificate will replace the expired one and will be reflected in the identity provider metadata.
2. Export or copy the updated metadata file from your identity provider, then upload it to Sauce Labs. For information on how to upload the metadata file, see Integrating With Sauce Labs Service Provider.

Sauce Labs Certificate Rotation

note

This section is relevant only for identity providers that enabled encryption of SAML Assertions.

If you enabled encryption of SAML Assertions in your IdP, you must upload the certificate that is provided in Sauce Labs metadata.

The certificate is valid for one year. 120 days before the expiration date the new certificate will be available in Sauce Labs metadata.

During the rotation period, the Sauce Labs metadata contains two valid certificates. If you are unsure which certificate to upload, copy the content of the <ds:X509Certificate> tag and paste it into a certificate decoder. Then, select the certificate that has a longer validity period.

To convert the certificate from the metadata into the PEM format required by most identity providers, you can use the online tool provided by OneLogin. Follow these steps:

1. Copy the content of the <ds:X509Certificate> tag, paste it into the X.509 cert text box, then click FORMAT X.509 CERTIFICATE.
2. Copy the content of the X.509 cert with header textbox and save it in a text file, for example saucelabs-sso.pem.
3. Upload the new certificate in your IdP.

If you encounter any issues during the certificate rotation, you can safely go back to the old certificate (until the expiration date). Both certificates will work.

danger

If you do not replace the encryption certificate in your IdP on time, once the certificate expires, any user from your organization will not be able to authenticate via SSO.

Integrating With Sauce Labs Service Provider

1. On Sauce Labs, click Account, and then click Team Management.

2. On the Organization Management page, in the ORGANIZATION SETTINGS section, click View Settings.

3. On the Organization Settings page, click the SINGLE SIGN-ON tab.

4. Upload the SAML metadata file provided by your IdP.

5. In the Status section, toggle the switch to Enabled. For more information about adding new users and SSO considerations, see Adding and Deactivating Users.

6. Test the integration.

Email domains

We strongly recommend that you assign your company email domains to your Sauce Labs organization. This allows users who do not have an account at Sauce Labs to initiate SSO at the Sauce Labs login page.

note

Contact support to assign email domains to your organization.

You can assign multiple domains.

Enforce SAML SSO

As an additional security measure, you can require users from your organization to sign in only via SAML SSO (IdP and SP-initiated flow). All other authentication methods will not be allowed.

You can toggle this setting in SSO settings:

Just-In-Time (JIT) Provisioning

Organization admins do not have to manually create accounts at Sauce Labs for new SSO users. JIT makes the onboarding process much more efficient.

New users can sign up via SP or IdP-initiated SSO and the new accounts at Sauce Labs will be created automatically.

tip

Make sure that you assign your company email domains to your SSO integration at Sauce Labs so that new accounts can be provisioning via the SP-initiated flow.

Team placement

Users who are created via SSO are placed into the default team.

Organization admins can assign users to other teams.

Usernames

Usernames for new accounts provisioned via SSO are generated according to the following pattern:

sso-<USERNAME_FROM_EMAIL_ADDRESS>-<EMAIL_HASH>

For example, if a new user has johndoe@example.com as their email address, their generated username would be:

sso-johndoe-4a74a9a

Including a random suffix is essential to guarantee the uniqueness of usernames in the Sauce Labs database.

Unsupported features

The following SSO-related features are currently not supported:

• SCIM (System for Cross-domain Identity Management)
• SLO (Single Logout)
• a staging environment for pre-integration testing of SSO
• integration with multiple identity providers in a single Sauce Labs organization