Zimbra cloud application

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

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

Set up SSO via SAML for Zimbra

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. From the Admin console Home page, go to Appsand thenSAML apps.
  3. Click Add at the bottom right.
  4. Locate and click Zimbra in the application list.
  5. On the Google IDP Information page:
    1. Copy the SSO URL and Entity ID values
    2. Download the Certificate.
  6. Click Next.

    The Basic information window shows the Application name and Description seen by users.

  7. Click Next.
  8. On the Service Provider Details page, edit the ACS URL and Entity ID, replacing {your-hostname} with the URL where you access your Zimbra instance.
  9. Click Finish.
Step 2: Set up Zimbra as a SAML 2.0 service provider (SP)
  1. Sign in to your Zimbra server console with root privileges and enter the following commands:
    • mkdir /opt/zimbra/lib/ext/saml 
    • cp /opt/zimbra/extensions-network-extra/saml/samlextn.jar /opt/zimbra/lib/ext/saml/
  2. Sign out, then back in to the Zimbra server as 'zimbra' user.
  3. Update the certificate:

    zmprov md {domain-name} zimbraMyoneloginSamlSigningCert "{certificate}"

    replacing {domain-name} with your Google domain name, and {certificate} with the contents of the Certificate you downloaded in Step 1.

  4. (Optional) Update the login and logout URLs:
    • zmprov md {domain-name} zimbraWebClientLoginURL {SSO-URL}
    • zmprov md {domain-name} zimbraWebClientLogoutURL {SSO-URL}

      replacing {domain-name} with your Google domain name, and {SSO-URL} with the SSO URL you downloaded in Step 1.

  5. Enter the following commands:
    • zmprov mcf zimbraCsrfRefererCheckEnabled FALSE
    • service zimbra restart
  6. (Optional) Enter the following commands to confirm your settings, replacing {domain-name} with your Google domain name:
    • zmprov gd {domain-name} zimbraMyoneloginSamlSigningCert
    • zmprov gd {domain-name} zimbraWebClientLoginURL
    • zmprov gd {domain-name} zimbraWebClientLogoutURL
    • zmprov gcf zimbraCsrfRefererCheckEnabled

 

Step 3: Enable the Zimbra app
  1. Sign in to your Google Admin console.

    Sign in using your administrator account (does not end in @gmail.com).

  2. From the Admin console Home page, go to Appsand thenSAML apps.
  3. Select Zimbra.
  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. To turn on or off a service only for users in an organizational unit:

    1. At the left, select the organizational unit.
    2. Select On or Off.
    3. To keep the service turned on or off even when the service is turned on or off for the parent organizational unit, click Override.
    4. If the organization's status is already Overridden, choose an option:
      • Inherit—Reverts to the same setting as its parent.
      • Save—Saves your new setting (even if the parent setting changes).

    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 Zimbra user account email IDs match those in your Google domain.
Step 4: Verify that the SSO is working

Zimbra 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 your administrator account (does not end in @gmail.com).

  2. From the Admin console Home page, go to Appsand thenSAML apps.
  3. Select Zimbra.
  4. At the top left, click Test SAML login

    Zimbra 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. Navigate to your Zimbra instance. You should be redirected to the Google sign-in page.
  3. Enter your username and password.

After your credentials are authenticated, you are redirected back to Zimbra.

Was this helpful?
How can we improve it?