Configure SAML for Gearset
Single Sign-On (SSO) lets your team sign in to Gearset using Okta as the identity provider (IdP). If you’re already signed in to Okta, you don’t need to enter your email or password again when you sign in from Gearset.
Contents
Prerequisites
- An Okta admin role that has permission to manage apps.
- Team owner access to your Gearset org.
Supported features
Gearset supports the following features when integrated with Okta:
- SP-Initiated SSO: Users can sign in directly from Gearset.
- IdP-Initiated SSO: Users can sign in directly from the Okta End-User Dashboard without accessing the Gearset sign-in page.
- Just-In-Time (JIT) provisioning: User accounts are automatically provisioned and assigned roles in Gearset after their first successful sign-in.
Configuration steps
Follow these steps to configure SAML for Gearset.
Retrieve Gearset values
To complete the setup in Okta, obtain the unique SAML Organization ID from the Assertion Consumer Service (ACS) URL from your Gearset account.
- Sign in to Gearset and go to My Account > Single Sign-On.
- Locate the ACS URL within your Gearset SAML configuration settings. For example:
https://app.gearset.com/saml/********************************/callback.
- The segment of the URL between /saml/ and /callback is your unique SAML Organization ID.
- Copy this ID and store it securely; it is necessary to complete the Okta configuration.
Configure the Gearset app in Okta
Follow these steps to activate the integration within your Okta tenant.
- Sign in to the Okta Admin Console.
- Go to Applications > Applications.
- Click Browser App Catalog.
- Search for Gearset and click Add Integration.
- On the General Settings tab, enter the values that you obtained in the previous step.
- Optional. Enter an Application label.
- Enter the Gearset org ID in the Unique SAML Organization ID field.
- Click Done.
- Go to the Authentication tab and copy the following values from the SAML 2.0 section:
- Issuer ID
- Single Sign-on URL
- SAML Signing Certificates
Configure SSO in Gearset
To complete the SSO configuration in Gearset, follow these steps:
- Sign in to Gearset and go to My Account > Single Sign-On.
- On the SAML authentication page, configure the following:
- SAML ID: Create a unique team ID (e.g., yourcompany-gearset). This ID will be used as part of your custom sign in URL.
- Issuer ID: Paste the Issuer ID from the Okta Sign on tab obtained in the previous step.
- Identity Provider Single sign-on URL: Paste the sign-on URL from the Okta Sign on tab obtained in the previous step.
- Active Signing Certificate: Open the downloaded certificate in a text editor and copy the full contents (including the -----BEGIN CERTIFICATE----- and -----END CERTIFICATE----- lines).
- Click Save configuration.
Verify SP-initiated SSO
SP-initiated SSO allows users to sign in to Okta directly from Gearset. This is the most common way for users to access the platform. There are two ways to perform this:
Sign in through Gearset
- Go to your Gearset sign-in page.
- Select SAML SSO / Identity Provider.
- Enter the SAML ID which was created in the previous step.
- Click Log in.
- You’re directed to a confirmation page; click Continue.
- Enter your Okta credentials on your company's sign-in page.
- After verification, you’re signed in to your Gearset dashboard.
Sign-in with a SAML SSO link
- Use the Login URL found in the SAML SSO configuration section (e.g.,
https://app.gearset.com/saml/yourcompany-gearset/login).
- Open the Login URL in your browser.
- You’re directed to the confirmation page prompting you to authenticate Okta tenant. Click Continue on the confirmation page.
- You’re redirected to your company’s Okta sign-in page. Enter your Okta credentials.
- After verification, you’re signed in to your Gearset dashboard.
Notes:
- Users performing a JIT flow using Identity Provider (IdP) are redirected to the application page and are required to verify their email address.
- For first-time Service Provider (SP) initiated sign in, users receives an invitation from the Gearset team owner to access the application.