How to Set Up Single Sign-On (SSO) for the Client Portal

Owned by Michelle Cabaya
Last updated: Apr 03, 2024
3 min read

Requires the “Single Sign-On (SSO)” permission. See Users.

Enterprise single sign-on (SSO) can be set up for your clients to use their company’s SSO when logging into the Client Portal.

Quick Tips:

  • Some SSO providers do not allow for users to be logged in from multiple locations.

  • SSO email login is not case sensitive.

When SSO is configured, users will first need to enter their email as the username.

Instructions

  • If the email address for a new SSO user is already associated with an existing internet user record, you will need to update the existing record with a different email or delete the record.

  • If you use a domain alias, you will need to use the domain alias for the Client Portal.

Create an Internet User Template

This will be the template that will be used to create internet user records for new SSO users upon their first login with SSO.

See https://cxtsoftware.atlassian.net/wiki/spaces/CXTsupport/pages/2604433409.

Submit Information to SSO Provider

Submit information to a new SSO identity provider. From the https://cxtsoftware.atlassian.net/wiki/spaces/CXTsupport/pages/3090448385 section, click the Centralized SSO Config icon to view the information.

Common setup requires a new SAML application created with your SSO provider. When setting up the SAML Application you will need the following information that can be found in the Centralized SSO Config:

  • Assertion Consumer Service (ACS) URL

  • Entity ID

The SAML Application may also require a Target Application URL. This URL is: https://nnnn0.cxtsoftware.net/Rapidship/#/sso-relay (replacing the nnnn with your CXT Software account number).

You may also need to map the Login credentials. By default, some SSO providers default this to “Username”, however, we use the “Email Address” as the username. This setting to remap the attribute can be called anything depending on your SSO provider, but it is commonly located in a section named something similar to “Attribute Mapping” and the setting itself may be labeled “saml_subject”. Please contact your SSO provider’s support for specific information.

Configure SSO

  1. Go to Maintenance > Single Sign-On (SSO).

  2. Click the + button in the top right.

See https://cxtsoftware.atlassian.net/wiki/spaces/CXTsupport/pages/3090448385