Setting up Jumpcloud SSO for Pequity

ⓘ You’ll need to have a Jumpcloud administrator account to setup the Pequity app & make the appropriate application configurations needed in your Jumpcloud account.

ⓘ You must be a Pequity administrator to make site-wide configurations in Pequity. This is something the Pequity team will handle on your behalf.

Configure Pequity Application in Jumpcloud

Sign into Jumpcloud with your admin account. On the left hand rail, select “SSO”

From there, click the “Add” button, then select “Custom SAML App” to create the Pequity app.

After selecting the add button, a configuration modal will pop up.

SPECIFY APP DETAILS

Under “general information,” please enter the following:

Display label: Pequity
Description: Helping your team make equitable pay decisions (this can be customized)
App Logo: You can download the app icon here.

SINGLE SIGN-ON CONFIGURATION

In the service provider details step, please enter the below. “Company” is your unique Pequity subdomain in the IDP Entity ID, SP Entity ID, and ACS URL links.

IDP Entity ID: https://[yourcompany].pequity.app/api/saml2/metadata
SP Entity ID: https://[yourcompany].pequity.app/api/saml2/metadata

📣 Please note that this Entity ID URL should NOT have a trailing slash. This is intentional. If a trailing slash is added to this link, the setup will not work.

ACS URL: https://[yourcomany].pequity.app/api/saml2/acs/
SP Certificate: Leave as default (Empty)
SAML Subject NameID: email
SAML Subject NameID Format: Leave as default
Signature Algorithm: Leave as default
Sign Assertion: Check this box
Default RelayState: Leave as default
IdP-Initiated URL: Leave as default
Declare Redirect Endpoint: Check this box
IDP URL: Leave as default

Next, fill out the attributes. These are case sensitive. The first value listed is the "Service Provider Attribute Name" and the second is "JumpCloud Attribute Name":

Email to email
first_name to firstname
last_name to lastname

APP ACTIVATION

After all of the above details have been entered, click “activate.”

A public certificate and private key pair are required to successfully connect any applications with Jumpcloud. After the Pequity app is saved and activated, Jumpcloud will automatically generate a public certificate and private key.

Sometimes the metadata will not be available for download in the below step until this certificate and key are generated.

DOWNLOAD METADATA

Once the app has been activated in your Jumpcloud account, you will need to download the Jumpcloud metadata and provide this to the Pequity team. To do so, open the Pequity app details in Jumpcloud and navigate to the “Single Sign On Configuration” section.

Under the Jumpcloud metadata, select “Export metadata” and send this XML file to your Pequity point of contact.

Determining User Access

After you’ve completed the above steps for the configuration of Pequity in your Jumpcloud account, you can determine which users you would like to have default access to Pequity.

In the “Pequity” app within your Jumpcloud admin, click on the “User Groups” panel. You can choose an existing user group in Jumpcloud or create a new group. Select the users you would like to give access to and then “save”.

You can view Jumpcloud’s help article here for how to set up a new user group.

Congratulations! You’ve setup Jumpcloud SSO for Pequity 🎉

🎉 All done! Questions?

We’re here to help! Drop us a line.