HipChat Server cloud application

You must be signed in as a super administrator for this task.

Using Security Assertion Markup Language (SAML), your users can use their Google Cloud credentials to sign in to enterprise-cloud applications.

Set up SSO via SAML for HipChat Server

Here's how to set up single sign-on (SSO) via SAML for the HipChat Server application.

Step 1: Set up Google as a SAML identity provider (IdP)

1. Sign in to your Google Admin console.

   Sign in using an account with super administrator privileges (does not end in @gmail.com).

2. In the Admin console, go to Menu  AppsWeb and mobile apps.
3. Click Add appSearch for apps.
4. Enter HipChat Server in the search field.
5. In the search results, hover over the HipChat Server SAML app and click Select. 
6. On the Google Identity Provider details page:
   • Copy and save the SSO URL.
   • Copy and save the Entity ID.
   • Download either the Certificate or the IDP metadata (you can use either one for SSO configuration).
7. Click Continue.
8. On the Service provider details page, replace {hipchat_server_ip_address} in both the ACS URL and Entity ID with your actual HipChat server IP address.
9. Click Continue.
10. (Optional) On the Attribute Mapping page, map Google directory attributes to corresponding application attributes:

    1. Click Add Mapping.
    2. Click the Select field menu and select a Google directory attribute.
    3. Enter the corresponding application attribute under App attributes.
11. (Optional) If you want to send a user’s group membership information in the SAML response, enter the group names that are relevant for this app in the Group membership field.

    1. Under Google groups, click in the Search for a group entry field.
    2. Type one or more letters of the group name.
    3. Choose the group name from the dropdown list.
    4. Add additional groups as needed (total groups cannot exceed 75).
    5. Under App attribute, enter the service provider’s corresponding groups attribute name.

    Note: Regardless of how many group names you enter, the SAML response will only include groups that a user is a member of (directly or indirectly). For more information, see About group membership mapping.

12. On the Attribute mapping page, click Finish.

Step 2: Set up HipChat Server as a SAML 2.0 service provider (SP)

1. Open a new incognito browser window.
2. Sign in to your HipChat Server instance at https://{hipchat_server_ip_address} with your organization's HipChat Server administrator account.
3. Navigate to Group admin > Authentication.
4. In Connect to your SAML identity provider, for Provider, choose 'Custom SAML 2.0'.
5. Do one of the following:
   • If you downloaded a certificate in Step 1, paste the contents into the Public Certificate field. Then continue with Steps 6 and 7.
   • If you downloaded IDP metadata in Step 1, paste the metadata into the Identity Provider metadata field. Go to Step 8.
6. Paste the Entity ID you copied in Step 1 into the Entity ID field.
7. Paste the SSO URL you copied in Step 1 into the SSO Endpoint field.
8. Click Save.

Step 3: Enable the HipChat Server app

1. Sign in to your Google Admin console.

   Sign in using an account with super administrator privileges (does not end in @gmail.com).

2. In the Admin console, go to Menu  AppsWeb and mobile apps.
3. Select HipChat Server.
4. Click User access.

5. To turn on or off a service for everyone in your organization, click On for everyone or Off for everyone, and then click Save.

6. (Optional) To turn a service on or off for an organizational unit:

   1. At the left, select the organizational unit.
   2. To change the Service status, select On or Off.
   3. Choose one:
      • If the Service status is set to Inherited and you want to keep the updated setting, even if the parent setting changes, click Override.
      • If the Service status is set to Overridden, either click Inherit to revert to the same setting as its parent, or click Save to keep the new setting, even if the parent setting changes.
        Note: Learn more about organizational structure.

7. (Optional) Turn on the service for a group of users.
   Use access groups to turn on a service for specific users within or across your organizational units. Learn more

8. Ensure that your HipChat Server user account email IDs match those in your Google domain.

Step 4: Verify that the SSO is working

HipChat Server supports both Identity Provider (IdP) initiated and Service Provider (SP) initiated SSO. Follow these steps to verify SSO in either mode:

IdP-initiated

1. Sign in to your Google Admin console.

   Sign in using an account with super administrator privileges (does not end in @gmail.com).

2. In the Admin console, go to Menu  AppsWeb and mobile apps.
3. Select HipChat Server.
4. At the top left, click Test SAML login. 

   HipChat Server should open in a separate tab. If it doesn’t, use the information in the resulting SAML error messages to update your IdP and SP settings as needed, then retest SAML login.

SP-initiated

1. Close all browser windows.
2. Open https://{hipchat_server_ip_address} and attempt to sign in. You should be automatically redirected to the Google sign in page.
3. Enter your sign in credentials.
4. After your sign in credentials are authenticated, you are automatically redirected back to HipChat Server.

 

_{Google, Google Workspace, and related marks and logos are trademarks of Google LLC. All other company and product names are trademarks of the companies with which they are associated.}