Apidog supports SAML 2.0-based single sign-on (SSO) for Enterprise organizations. This guide shows how to configure JumpCloud as a SAML 2.0 identity provider for your Apidog organization.This guide uses JumpCloud as a SAML 2.0 identity provider. Apidog does not require a JumpCloud-specific integration type.
Configuration overview#
You need to exchange SAML configuration information between Apidog and JumpCloud.| From | Copy | Paste to |
|---|
| Apidog | ACS URL | JumpCloud SAML application |
| Apidog | SP Identifier / Entity ID | JumpCloud SAML application |
| JumpCloud | IdP Sign-on URL | Apidog SSO settings |
| JumpCloud | IdP Entity ID / Issuer | Apidog SSO settings |
| JumpCloud | Public certificate | Apidog SSO settings |
Step 1: Open SSO settings in Apidog#
In Apidog, go to your organization settings and open the Single Sign-On page.Enable SAML SSO if it is not already enabled.Copy the following service provider information from Apidog:Organization SSO sign-on URL
Step 2: Create a SAML application in JumpCloud#
In JumpCloud, create a new SAML application for Apidog, or edit an existing one.Enter the Apidog service provider information into the JumpCloud SAML application.| JumpCloud field | Value |
|---|
| ACS URL | The ACS URL copied from Apidog |
| SP Entity ID / Identifier | The SP Identifier copied from Apidog |
Field names in JumpCloud may vary slightly depending on the JumpCloud console version. Use the fields corresponding to the ACS URL and SP Entity ID.
| Apidog field | Value from JumpCloud |
|---|
| IdP Sign-on URL | JumpCloud SSO URL / Login URL |
| Issuer | JumpCloud IdP Entity ID / Issuer |
| Public Certificate | JumpCloud SAML certificate |
If JumpCloud provides signature or digest algorithm settings, make sure they are compatible with the selected values in Apidog.Step 4: Save and test SSO#
Save the SAML SSO configuration in Apidog.Then test signing in using the organization SSO sign-on URL.If the configuration is correct, users assigned to the JumpCloud SAML application can sign in to Apidog through SSO.Troubleshooting#
| Issue | Possible cause | Solution |
|---|
| SSO sign-in fails after redirecting from JumpCloud | ACS URL or SP Identifier is incorrect | Check that the values copied from Apidog match the JumpCloud SAML application exactly. |
| Apidog reports an invalid issuer | The JumpCloud issuer value is incorrect | Copy the IdP Entity ID / Issuer from JumpCloud again and update it in Apidog. |
| Certificate validation fails | The certificate is missing, expired, or incorrectly copied | Re-copy the public certificate from JumpCloud and save the SSO configuration again. |
| Users cannot access the SAML app | Users are not assigned to the JumpCloud application | Assign the required users or groups to the JumpCloud SAML application. |
