Set up SAML SSO for self hosted Jama Connect Interchange

Daniel Sardina
Daniel Sardina
  • Updated
  • Jama Connect Interchange™

Summary

This article explains how a Root Admin configures SAML single sign-on (SSO) for self-hosted Jama Connect Interchange™ (JCI), connects an identity provider (IdP), and verifies user access. Self-hosted JCI uses the SAML service supplied with the installation.

JCI Cloud customers: Contact Jama Support to arrange SSO setup. Support provisions SSO for Cloud instances; the self-hosted instructions below do not apply to Cloud.

Resolution

Before you begin

You need authorized access to the root account and System admin → Application authentication. Regular administrators cannot change these settings. Confirm that your installation’s SAML service is ready and that you can restore Root Admin access if SSO fails. Contact Jama Support if these prerequisites are unavailable.

Work with your IdP administrator to prepare one SAML 2.0 application, an HTTPS metadata URL or XML document, distinct first- and last-name attribute names, and a test identity. Create and activate its JCI account first; SSO does not create accounts or assign trial licenses. The email returned through the SAML service must match exactly one active JCI account. Matching is case-insensitive.

Users must start sign-in from JCI. IdP-initiated sign-in is unsupported.

Retrieve the initial Root Admin Password
For a new installation or the first upgrade to JCI 2.0 or later, retrieve the generated initial root password on the host server. Skip this step if you have already retrieved it. After services start, allow a few minutes for initialization, then run:

sudo docker exec config-svc-interchange grep -Fn \
'Created self-hosted root user and assigned ROLE_ROOT. Initial root password (logged once)' \
logs/config-svc.log

Use the returned password to sign in to the root account for System admin. Store it securely and exclude the command output from screenshots or support requests. If the initial password cannot be retrieved, contact Jama Support.

Configure authentication in Root Admin

Sign in as root, open System admin → Application authentication, and select Edit. Choose SAML for IdP sign-in or Multiple (Basic + SAML) to support accounts assigned either SSO or username and password authentication.

Enter the SAML service URL supplied for your installation. This internal address lets JCI contact the SAML service; it is different from the public endpoints used by browsers and your IdP.

Open View service provider details and copy the ACS / single sign-on URL and SP entity ID / audience restriction. Use these displayed values for your IdP configuration. If the public host, scheme, or port is incorrect or unreachable, have your deployment administrator correct it before proceeding.

 

Configure your identity provider

Enter the copied ACS URL and entity ID in the IdP application. Configure the email and name attributes, assign the test identity, and confirm that the metadata contains the intended signing certificate and sign-in endpoint. Verify the email returned through the SAML service; the IdP’s NameID alone does not establish which email JCI receives.

Save the SSO settings

Back in Root Admin, choose URL or XML for Metadata input method. Enter the HTTPS metadata endpoint in Metadata URL, or paste the document into Metadata XML. Use the metadata endpoint rather than the IdP’s sign-in URL.

Enter the distinct First-name attribute mapping and Last-name attribute mapping. Match on field is fixed to Email. Set ACS binding only if your IdP configuration requires it; otherwise, leave it empty.

Review the settings, select Save, and wait for Configuration saved. Correct any reported errors before continuing. XML configurations display XML configured in the saved view; re-enter the XML when saving later edits.

Assign user methods and test sign in

Switching from Basic to SAML assigns existing regular users to SAML. Switching from Basic to Multiple leaves existing regular users on Basic. In Root Admin’s Users view, assign SAML to each account that should use SSO. New users default to SAML in Multiple mode. Review assignments after every mode change; protected local administrator accounts remain Basic.

In a new browser session, open the JCI login page and start SSO there. In Multiple mode, select Log in with SSO. Confirm that you return as the intended user, then sign out and test again. In Multiple mode, also test a Basic account with the username and password form. Confirm that authorized Root Admin access remains available before leaving SAML-only mode enabled.

Additional Resources (for all external articles)

Feedback:
We welcome your input! Please sign in to leave any comments, suggestions, or ideas for improvement below.

Was this article helpful?

0 out of 0 found this helpful

Have more questions? Submit a request

Comments

0 comments

Please sign in to leave a comment.