Configuring Single Sign On

The Single Sign On (SSO) authentication method permits Users to access pages in xMatters directly without first logging in via the Sign In page. This method uses an external authentication module, and supplies an authentication string to xMatters.

Note: xMatters does not currently support SSO with xMatters on demand or xMatters enterprise deployments with multiple Companies.

To use SSO authentication, the following criteria must be met:

Note: Before configuring SSO, ensure that the Allow Single Sign On check box is selected on the Company's details page in the web user interface.

The HTTP headers must contain the following three lines:

HTTP_SM_AUTHENTIC = “YES”
HTTP_SM_AUTHORIZED = “YES”
HTTP_SM_USER = “<User web login ID>”
Note: The “HTTP_” portion of the header lines is optional, but all three lines must use the same convention.

When the criteria have been met, Users can directly access any page that is normally accessed via the main xMatters menus on the left side of the screen. For example, a User authenticated with SSO can navigate directly to their Active Alerts page using the following URL:

<xMattersIP>/alarmpoint/Alerts/ActiveAlerts/ActiveAlerts.do
 

Note that the semi-colon and the session information that follows in the URL shown in your browser is not included in the URL initially used to load a page using SSO.

To reach the Sign In page and log in to xMatters as a different User when an SSO deployment portal is in place, click the Sign Out link at the top of any page. You can then sign in using any authorized xMatters web login ID and password.

xMatters also redirects to the default Sign In page in any of the following circumstances:

If the User authenticated by SSO does not have permission to view the page specified in the URL, xMatters redirects them to a standard access denied page. If the User accesses xMatters through the default URL, xMatters redirects them automatically to their home page.

Configuring SSO header variable names

By default, xMatters is configured to use SiteMinder Web Access Manager SSO headers; i.e., SM_AUTHENTIC, SM_AUTHORIZED, SM_USER. You can modify the SSO header names that xMatters expects by adding a new properties file and setting the modified header names as required.

Note: These steps must be carried out on all web servers in your xMatters deployment.
To change the SSO header variables:
  1. Navigate to the <xMHOME>/webserver/webapps/cocoon/WEB-INF/classes folder and open the default.properties file in an editor.
    1. The properties file contains the following settings:
sso.config.authenticateHeader=SM_AUTHENTIC
sso.config.authorizedHeader=SM_AUTHORIZED
sso.config.userHeader=SM_USER
  1. Modify the value entries as necessary and save the file as custom.properties.
Note: Do not overwrite, delete, or modify the default.properties file; make changes to the custom.properties file only.
  1. Restart the web server.