Topic

How to update the organization-level metadata for single sign-on (SSO) in the Everbridge Member Portal.

Description

Organizations belonging to the same Everbridge account may be configured to have different Member Portal SSO configurations. The Everbridge system has the capability to accept one metadata file per organization within the account instead of having an umbrella metadata file covering all organizations. This guide provides the steps to upload a new metadata file into the Single Sign-On (SSO) settings at the Organization level in the Everbridge Member Portal. 

After acquiring a new certificate or the identity provider (IdP) system settings have changed, follow the steps listed below.

Prepare Your Organization

Before making changes, communicate to users that SSO is scheduled for reconfiguration.

If users do not already have break glass access, see knowledge article EBS: Single Sign-On (SSO) Break Glass Access in Everbridge Suite. Using break glass access ensures that the Everbridge platform can still be accessed in cases of emergency without issues during the reconfiguration.

Backup The Existing Configuration

1. Log in to the Manager Portal and select the appropriate Organization from the upper right-hand corner.
2. Select Settings tab from the top menu bar.
3. Select Security from the menu on the left.
4. Select Single Sign-On for Member Portal from the sub-menu.
5. Capture a screenshot or copy/paste the existing configuration information into Notepad.
6. Click Download at the bottom of the page to download the existing metadata file.

Updating Only the Identity Provider Metadata File

1. Log in to the Manager Portal as an Organization Administrator.
2. Select Settings from the top menu bar.
3. Select Security from the menu on the left.
4. Select Single Sign-On for Member Portal from the sub-menu.
5. Select the Edit Pencil to the right of the name of the current Metadata File.
6. From your files, choose the name of the new metadata file.
7. Select Open.
8. Click Save.
9. Procced to Testing the SSO configuration.

Reconfigure Member Portal SSO Settings

1. Log in to the Manager Portal as an Account Administrator.
2. Select Settings tab from the top menu bar.
3. Select Security from the menu on the left.
4. Select Single Sign-On for Member Portal from the sub-menu.
5. Click the white Remove button to clear the existing configuration. 
6. Using the backup you created, re-enter the Name for your SSO instance.
7. Using the backup you created, re-enter your API Name. The API name must exactly match what you chose for the Entity ID and ACS URLs.  
8. Upload the Identity Provider Metadata file by clicking Choose File.
9. Select the appropriate radio button for the Security Hash Algorithm.
10. Click Save.
11. Optional: Check the box for Mobile App to allow SSO access via the Everbridge Mobile App.

12. Click Save a second time to instigate the option to Download the metadata file from Everbridge. Once the Download link appears above the Save button, reconfiguration is completed.

Test the New SSO Configuration

Request a few users to attempt logging in via SSO. If the users are unable to log in:

1. Capture screenshots and specific error messages.
2. Restore the prior configuration by clicking Remove, re-entering the settings captured during the Backup Existing Configuration step, and uploading the original metadata file downloaded during the Backup Existing Configuration step.
3. Reach out to the IdP administrator to determine whether there is an error happening on the IdP side.
4. Open a case with Everbridge Technical Support and note the following:
   1. Specific error received
   2. Impacted user
   3. Username entered upon logging in
   4. Date/time of the failed sign-in attempt.

Related Articles:

EBS: Troubleshooting Single Sign-On (SSO) in Everbridge Suite
EBS: Troubleshooting & Configuration Guide for Single Sign-On (SSO) - Main Page

Download XML for Record Keeping

If the reconfiguration was successful, download the XML file used to create this new SSO configuration for record keeping and follow the steps below:

1. Log in to the Manager Portal as an Account Administrator.
2. Select Settings from the top menu bar.
3. Select Security from the menu on the left.
4. Select Single Sign-On for Manager Portal from the sub-menu.
5. Scroll to the bottom of the configuration settings and click the Download link and save the XML file. (Note: If you have not configured SSO for the Member Portal, there will be no Download link.)