Setting Up SSO/Authentication¶
Overview¶
CxPortal supports two methods for signing in:
- Username and password (enabled by default for all customers).
- Single sign-on (SSO) via Microsoft Entra ID (Azure AD), available as an opt-in.
Important: SSO is required to access CxPortal during a regional outage. Username and password authentication is not available when the primary AWS region is unavailable. For details on what is and is not available during an outage, see the Multi-Region Resiliency page.
Comparing Login Methods¶
| Username and Password | SSO (Entra / Azure AD) | |
|---|---|---|
| Enabled by default | Yes | No (opt-in) |
| Available during normal operation | Yes | Yes |
| Available during a regional outage | No | Yes |
| Setup required | None | Submit a support request and configure Entra |
Username and Password¶
Username and password is the default authentication method for all CxPortal customers. No setup is required. Users sign in with the credentials issued to them by their CxPortal administrator.
Limitations¶
Username and password authentication runs only in the primary AWS region. If the primary region is unavailable, users cannot sign in to CxPortal using this method. To maintain access during a regional outage, enable SSO.
Single Sign-On (SSO)¶
CxPortal supports SSO through Microsoft Entra ID (Azure AD). Entra is currently the only supported identity provider. With SSO enabled, users sign in to CxPortal using their existing corporate credentials.
SSO is deployed across both AWS regions, so users with SSO can continue to sign in to CxPortal during a regional outage.
Enabling SSO for Your Organization¶
Enabling SSO is a five-step process. Some steps are performed by your organization in the Microsoft Entra admin center. Other steps are performed by Caylent after you submit a support request.
Before You Begin¶
You will need:
- Access to your organization's Microsoft Entra admin center
- A user with permission to register applications in Entra
- A secrets vault or password manager to store credentials securely
Step 1: Submit a Support Request to Caylent¶
Contact Caylent to begin SSO onboarding by submitting a support request. Indicate that you want to enable SSO for your organization.
For instructions, see the Submit a Support Request page.
Important: Caylent will confirm receipt and let you know when you can begin the Entra configuration steps below.
Step 2: Register a New Application in Microsoft Entra ID¶
Register a new application in the Microsoft Entra admin center. This application is used to federate authentication with CxPortal.
- In the Microsoft Entra admin center, navigate to App registrations.
- Click + New registration.
- Enter a display name for the application. For example: CxPortal or \
CxPortal. - Select the supported account type appropriate for your organization.
- Leave the Redirect URI field blank. You will add this in Step 5, after Caylent provisions your user pool.
- Click Register.
Step 3: Create a Client Secret¶
Create a client secret that CxPortal will use to authenticate with Entra ID.
- From the application you just registered, navigate to Certificates & secrets.
- Click + New client secret.
- Enter a description and select an appropriate expiration period.
- Click Add.
- Copy the client secret value immediately and store it in a secure location such as a password manager or secrets vault.
Warning: The client secret is displayed only once at the time of creation. If you navigate away from the page without copying it, you will need to create a new secret.
Step 4: Collect Application Identifiers and Send to Caylent¶
From the application's Overview page in the Entra admin center, collect the following values:
- Application (client) ID
- Directory (tenant) ID
- Client secret (copied in Step 3)
Send these values to Caylent securely through the support request from Step 1. Caylent will use these values to provision your CxPortal user pool.
Note: Caylent will provision your user pool and then send you a redirect URI to use in the next step. Wait for Caylent to confirm provisioning is complete before continuing to Step 5.
Step 5: Configure the Redirect URI in Entra ID¶
Once Caylent confirms that your user pool has been provisioned, they will send you a redirect URI. Add this redirect URI to your Entra application registration. This allows Entra to redirect users back to CxPortal after authentication.
- Return to your application in the Microsoft Entra admin center.
- Navigate to Authentication.
- Click + Add Redirect URI, then select Web.
- Enter the redirect URI provided by Caylent. It will follow this format:
https://<provided-domain>/oauth2/idpresponse
- Click Configure to save.
Verifying SSO Is Working¶
Once Step 5 is complete, Caylent will notify you that SSO is ready to use. To verify:
- Navigate to the CxPortal login page.
- Select the SSO sign-in option.
- You will be redirected to your organization's Entra sign-in page.
- Sign in with your corporate credentials.
- You should be redirected back to CxPortal and signed in successfully.
If sign-in fails, contact Caylent support and reference your original support request.
Process Summary¶
The table below summarizes who is responsible for each step in the SSO setup process.
| Step | Action | Owner |
|---|---|---|
| 1 | Submit a support request to Caylent | Customer |
| 2 | Register application in Entra ID | Customer |
| 3 | Create client secret and store securely | Customer |
| 4 | Send client ID, tenant ID, and client secret to Caylent | Customer |
| 5 | Provision the CxPortal user pool and send redirect URI | Caylent |
| 6 | Add redirect URI to Entra application | Customer |
Related Pages¶
- Multi-Region Resiliency — how CxPortal stays available during a regional outage
- Submit a Support Request — how to contact Caylent for SSO onboarding and other requests