How to Activate Single Sign On (SSO) in RMS
Overview
Single Sign On (SSO) allows users to access multiple applications using a single login with an Identity Provider.
Single Sign On (SSO) centralises user authentication to a single Identity Provider (IdP) that can provide access to multiple configured applications.
Activating SSO in RMS will require users to be authenticated by the Identity Provider to access RMS.
Important! RMS must be set up in the Identity Provider before activating SSO in RMS. Activating SSO in RMS without completing the necessary setup in the IdP will lock all users out of RMS.
Set Up SSO for the RC (Early Access) Environment
SSO customers must add the RMS Release Candidate (RC) environment to their Identity Provider (IdP) so that users can still sign in to RMS when the property is moved to RC for Early Access to new features.
RMS moves properties between the Live environment (app.rmscloud.com) and the RC environment (rcapp.rmscloud.com) as part of the RMS Application Updates & Release Cycle. If the IdP only holds the Live (app.rmscloud.com) values, users cannot sign in to RMS while the property is on RC.
Please Note! Pass this section to the IT Administrator or Microsoft Entra ID (Azure) administrator. The changes in this section are made in the IdP.
Add the RC Identifier and Reply URL
The RC Identifier (Entity ID) and the RC Reply URL for the property's region are added in the IdP alongside the existing app.rmscloud.com configuration.
RC Identifier / Entity ID: https://rcapp.rmscloud.com
RC Reply URL / Assertion Consumer Service (ACS) URL:
| Region | RC Reply URL / ACS |
|---|---|
| APAC (Asia Pacific) | https://rcapp12.rmscloud.com/SAML/Assertion |
| Americas | https://rcapp13.rmscloud.com/SAML/Assertion |
| EMEA (Europe, Middle East and Africa) | https://rcapp14.rmscloud.com/SAML/Assertion |
Tip! The region number in the RC Reply URL matches the number in the property's RMS web address after signing in. For example, a property that signs in to app12.rmscloud.com uses https://rcapp12.rmscloud.com/SAML/Assertion.
Tip! RMS uses the Live SSO configuration for RC when no separate RC configuration exists in Setup > Security > SSO, provided the IdP Issuer, Login URL, Logout URL, and certificate are the same for both environments. A separate RC configuration in RMS is only needed when the IdP uses different values for RC.
Microsoft Entra ID: Allow the App Registration for RC
Properties that use Microsoft Entra ID (formerly Azure Active Directory) as their IdP must also make sure the app registration used for RMS SSO accepts sign-ins from the directory their staff sign in from. If the app registration only allows accounts in its own organisation (single-tenant), Microsoft blocks the sign-in and staff may see Microsoft error AADSTS650059.
The IT Administrator can resolve this with either of the following options:
- Option 1 - Update the app registration: Open the app registration for RMS in Microsoft Entra ID (identified by its Application (client) ID, which is not the RMS Client ID) and change the supported account type to allow accounts in any organisation (multi-tenant).
- Option 2 - Confirm the app's directory: Make sure the app is registered in the same Microsoft Entra ID directory that staff signs in from.
Please Note! IT Administrators should consult the Microsoft Entra ID documentation for further assistance with these settings.
Setup
The following setup will need to be completed by the IT Administrator and an RMS System Administrator.
Step 1 - Add RMS in the IdP
This step is performed outside of RMS and should be completed by the IT Administrator.
Add RMS as a SAML Application or Endpoint with the Identity Provider (IdP) using the information below.
RMS Live Entity ID: https://app.rmscloud.com
RMS RC Entity ID: https://rcapp.rmscloud.com
RMS Digital Registration Card Entity ID: https://app12.rmscloud.com/sso/ClientID?appId=13
Live Assertion URL (Reply URL / ACS):
- APAC (Asia Pacific): https://app12.rmscloud.com/SAML/Assertion
- Americas: https://app13.rmscloud.com/SAML/Assertion
- EMEA (Europe, Middle East and Africa): https://app14.rmscloud.com/SAML/Assertion
RC Assertion URL (Reply URL / ACS):
- APAC: https://rcapp12.rmscloud.com/SAML/Assertion
- Americas: https://rcapp13.rmscloud.com/SAML/Assertion
- EMEA: https://rcapp14.rmscloud.com/SAML/Assertion
Tip! Use the Live and RC Assertion URLs for the property's region. The number in the URL matches the property's RMS web address after signing in. For example, a property that signs in to app12.rmscloud.com uses the APAC URLs.
Login URL:
- https://app.rmscloud.com/sso/ClientID
Attributes
- Name: ClientID
- Value: Your RMS Client Number
Please Note! Replace ClientID with the property's RMS Client ID. For Enterprise Properties, this is the Owner's RMS Client ID.
Tip! SSO can be configured separately for the Live and RC environments.
Tip! The complete property-specific URL can be obtained by logging into RMS using an Internet Browser and copying the URL after successful login.
Please Note! IT Administrators should consult the documentation of their Identity Provider for further assistance with this step.
Important! Complete the following before continuing:
✓ Add RMS to the IdP
✓ Test SSO Login in the IdP
✓ Download the Issuer Certificate
Step 2 - Setup SSO in RMS
After RMS has been added to the Identity Provider, SSO can be activated in RMS.
Selecting the SSO Username Type as 'Federation ID' will require a Federation ID to be setup on all RMS Users before continuing.
Please Note! SSO cannot be trialled independently in the RMS Training Database.
Use the 'Test Login' or 'Test Application' feature within the IdP to ensure RMS has been added correctly prior to activating SSO in RMS.
Have your System Administrator complete the following.
In the side menu of RMS, go to Setup > Security.
- Navigate to the 'SSO' tab.
- Select the '+' (Add) icon to open the SSO Configuration dialog (or select an existing environment row and click the pencil edit icon to update it).
- Select the Environment.
- Toggle 'SSO Enabled' on.
- Enter the Issuer.
- Upload the Identity Provider Certificate.
- Enter the Login URL.
- Enter the Logout URL.
- Select the SSO Username Type.
- Select the SSO Username Location.
- Optional: Enter the Attribute Name (required if 'Username is in an attribute element' is selected).
- Optional: Enter the Name ID format.
- Select 'Save/Exit'.
Please Note! New SSO configurations can only be created for the Live and RC environments. If an existing SSO configuration for Beta or another legacy environment is already in place, it will remain visible in the list and can be viewed, disabled, or deleted - but cannot be recreated once removed.
Important! Users will be locked out of RMS if the appropriate setup and testing have not been completed in the IdP before saving.
Please Note! Identity Provider Certificates will be in the file format of .txt, .cer, or .pfx.
Selecting the SSO Username Type as 'Federation ID' requires a Federation ID to be setup on all RMS users before continuing.
Selecting the SSO Username Location as 'Username is in an attribute element' requires an Attribute Name to be specified.
Finished
SSO is now active in RMS.
Users will need to be logged in and authenticated with the Identity Provider to gain access to RMS.
Tip! Use the URL below in the Internet Browser to access the RMS Training Database when SSO is active in RMS.
Replace ClientID in the URL below with the property's RMS Client ID.
https://app.rmscloud.com/sso/ClientID/training
Comments
0 comments
Please sign in to leave a comment.