Google SAML Implementation

Category: Login with SSO
On this page:

    This article contains Google Workspace-specific help for configuring Login with SSO via SAML 2.0. For help configuring Login with SSO for another IdP, refer to SAML 2.0 Configuration.

    Configuration involves working simultaneously with the Bitwarden Web Vault and the Google Workspace Admin console. As you proceed, we recommend having both readily available and completing steps in the order they’re documented.

    Tip

    Already an SSO expert? Skip the instructions in this article and download screenshots of sample configurations to compare against your own.

    Download Sample

    Open SSO in the Web Vault

    If you’re coming straight from SAML 2.0 Configuration, you should already have an Organization ID created. If you don’t refer to that article to create an Organization ID for SSO.

    Navigate to your Organization’s ManageSingle Sign-On screen:

    SAML 2.0 Configuration
    SAML 2.0 Configuration

    You don’t need to edit anything on this screen yet, but keep it open for easy reference.

    Create a SAML app

    In the Google Workspace Admin console, select AppsWeb and mobile apps from the navigation. On the Web and mobile apps screen, select Add AppAdd custom SAML app:

    Create a SAML App
    Create a SAML App

    App details

    On the App details screen, give the application a unique Bitwarden-specific name and select the Continue button.

    Google Identity Provider details

    On the Google Identity Provider details screen, copy your SSO URL, Entity ID, and Certificate for use during a later step:

    IdP Details
    IdP Details

    Select Continue when you’re finished.

    Service provider details

    On the Service provider details screen, configure the following fields:

    Field Description
    ACS URL Set this field to the pre-generated Assertion Consumer Service (ACS) URL retrieved from the Bitwarden SSO configuration screen.

    For Cloud-hosted customers, this is always https://sso.bitwarden.com/saml2/your-org-id/Acs. For self-hosted instances, this is determined by your configured server URL, for example https://your.domain/sso/your-org-id/Acs.
    Entity ID Set this field to the pre-generated SP Entity ID retrieved from the Bitwarden SSO Configuration screen.

    For Cloud-hosted customers, this is always https://sso.bitwarden.com/saml2. For self-hosted instances, this is determined by your configured server URL, for example https://your.domain.com/sso/saml2.
    Start URL Optionally, set this field to the login URL from which users will access Bitwarden.

    For Cloud-hosted customers, this is always https://vault.bitwarden.com/#/sso. For self-hosted instances, this is determined by your configured server URL, for example https://your.domain.com/#/sso.
    Signed response Check this box if you want Workspace to sign SAML responses. If not checked, Workspace will sign only the SAML assertion.
    Name ID format Set this field to the SAML NameID format for Workspace to use in SAML responses.
    Name ID Select the Workspace user attribute to populate NameID.

    Select Continue when you’re finished.

    Attribute mapping

    On the Attribute mapping screen, select the Add Mapping button and construct the following mapping:

    Google Directory attributes App attributes
    Primary email email

    Select Finish.

    Turn On the App

    By default, Workspace SAML apps will be OFF for everyone. Open the User Access section for the SAML app and set to ON for everyone or for specific Groups, depending on your needs:

    User Access
    User Access

    Save your changes.

    Back to the Web Vault

    At this point, you’ve configured everything you need within the context of the Google Workspace Admin console. Jump back over to the Bitwarden Web Vault to complete configuration.

    The Single Sign-On screen separates configuration into two sections:

    • SAML Service Provider Configuration will determine the format of SAML requests.
    • SAML Identity Provider Configuration will determine the format to expect for SAML responses.

    Service Provider Configuration

    Configure the following fields according to the choices selected in the Workspace Admin console during setup:

    Field Description
    Name ID Format Set this field to the Name ID format selected in Workspace.
    Outbound Signing Algorithm The algorithm Bitwarden will use to sign SAML requests.
    Signing Behavior Whether/when SAML requests will be signed.
    Minimum Incoming Signing Algorithm By default, Google Workspace will sign with RSA SHA-256. Select sha-256 from the dropdown.
    Want Assertions Signed Whether Bitwarden expects SAML assertions to be signed. By default, Workspace SAML Apps will sign SAML assertions, so you may check this box.
    Validate Certificates Check this box when using trusted and valid certificates from your IdP through a trusted CA. Self-signed certificates may fail unless proper trust chains are configured with the Bitwarden Login with SSO docker image.

    When you’re done with the Service Provider Configuration section, Save your work.

    Identity Provider Configuration

    Identity Provider Configuration will often require you to refer back to the Workspace Admin console to retrieve application values:

    Field Description
    Entity ID Set this field to Workspace’s Entity ID, retrieved from the Google Identity Provider details section or using the Download Metadata button.
    Binding Type Set to HTTP POST or Redirect.
    Single Sign On Service URL Set this field to Workspace’s SSO URL, retrieved from the Google Identity Provider details section or using the Download Metadata button.
    Single Log Out URL Login with SSO currently does not support SLO. This option is planned for future development, however you may pre-configure it if you wish.
    Artifact Resolution Service URL For Workspace SAML app implementations, leave this field blank.
    X509 Public Certificate Paste the retrieved Certificate, removing -----BEGIN CERTIFICATE----- and -----END CERTIFICATE-----.

    Extra spaces, carriage returns, and other extraneous characters will cause certifiation validation to fail.
    Outbound Signing Algorithm By default, Google Workspace will sign with RSA SHA-256. Select sha-256 from the dropdown.
    Allow Unsolicited Authentication Response Login with SSO currently does not support unsolicited (IdP-initiated) SAML assertions. This option is planned for future development.
    Disable Outbound Logout Requests Login with SSO currently does not support SLO. This option is planned for future development.
    Want Authentication Requests Signed Whether Google Workspace expects SAML requests to be signed.

    When you’re done with the Identity Provider Configuration section, Save your work.

    Test the Configuration

    Once your configuration is complete, test it by navigating to https://vault.bitwarden.com and selecting the Enterprise Single Sign-On button:

    Enterprise Single Sign-On button
    Enterprise Single Sign-On button

    Enter the configured Organization Identifier and select Log In. If your implementation is successfully configured, you’ll be redirected to the Google Workspace login screen:

    Login
    Login

    After you authenticate with your Workspace credentials, enter your Bitwarden Master Password to decrypt your Vault!