Configuring directory sync with G Suite (Google)

This article will cover how to connect the bitwarden Directory Connector tool to your G Suite directory.

Requirements

  • Read through the following article: Syncing users and groups with a directory
  • Install bitwarden Directory Connector
  • Using Directory Connector, log into your bitwarden account and select your enterprise organization

Table of Contents

Create a Google Cloud Project

Note

If you already have a Google Cloud project available, you can skip this step and re-use it here.

  1. Go to https://console.cloud.google.com
  2. Click Create Project
  3. Enter a project name and click Create
  4. Refresh the page and you should now see your project

Enable the Admin SDK API for Your Project

  1. Go to https://console.cloud.google.com
  2. Make sure the appropriate project is selected.
  3. Open the navigation menu and navigate to API Manager -> Dashboard.
  4. Select the Enable API button near the top.
  5. Click the Admin SDK link under the Google Apps APIs section.
  6. Click the Enable button near the top.

Create & Configure a Service Account

  1. Go to https://console.cloud.google.com
  2. Make sure the appropriate project is selected.
  3. Open the navigation menu and navigate to API Manager -> Credentials.
  4. Click the Create credentials button and select Service account key.
  5. Select New service account.
  6. Name the service account bitwarden Directory Connector. For the role, select Project and then Owner. Ensure that JSON is the selected Key type. Upon clicking Create, a JSON file will be downloaded; this is important for later so keep a note of where you have downloaded it.
  7. You should now see your newly created service account listed. Click on Manage service accounts (on the right-hand side).
  8. Select the options button next to your service account, and select Edit.
  9. Check the box “Enable G Suite Domain-wide Delegation”, enter anything for “Product name for the consent screen” and click Save.
  10. Click View Client ID and you’ll see the Client ID on screen. You will need the Client ID to configure security within G Suite. Highlight the Client ID and copy it to your clipboard.

Configure G Suite Security

  1. Go to https://admin.google.com
  2. Open the navigation menu and navigate to Security.
  3. Select the API reference option and make sure Enable API access is checked.
  4. Back in the list of options, select Show more -> Advanced settings -> Manage API client access
  5. For Client Name, paste the Client ID of the service account that you created in the previous steps. For API Scopes, paste the following values to grant read-only access to users and groups:
    https://www.googleapis.com/auth/admin.directory.user.readonly,https://www.googleapis.com/auth/admin.directory.group.readonly,https://www.googleapis.com/auth/admin.directory.group.member.readonly
  6. Click the Authorize button to save.
  7. You should now see your service account listed as an authorized client of G Suite.

Configure Directory Connector

  1. Locate the secret key JSON file that was downloaded whenever you created your service account in the steps above.
  2. Copy this file to the bitwarden Directory Connector program data folder at C:/ProgramData/bitwarden/Directory Connector.
    • Optionally rename the JSON file to something that is easier to remember, such as client_secret.json
  3. Launch the Directory Connector console by double clicking the shortcut.
  4. Select option 3 (Configure directory connection) from the main menu.
  5. Select G Suite Directory as the type.
  6. Enter the name of the JSON file that you copied in step 2.
  7. Enter the domain of your G Suite account.
  8. Enter the email address of an admin user that has full access to the G Suite directory (such as your own).

Congrats! You are done configuring G Suite with the bitwarden Directory Connector.

Testing

Test your configurations by running a simulated directory sync. You should see your G Suite groups and/or users printed to the screen.

Was this helpful?

Rate this article:

Email Us

Want to talk to a human?

Send Us An Email