Google Workspace

Professional Enterprise

runZero integrates with Google Workspace to allow you to sync and enrich your asset inventory, as well as gain visibility into users and groups. Adding your Google Workspace data to runZero makes it easier to find unmanaged assets on your network.

The following Google Workspace registered asset types are supported:

  • ChromeOS devices
  • Mobile devices
  • Endpoint devices

How runZero maps Google Workspace devices to assets:

  • For devices that can be matched to an existing runZero asset, asset-level attributes such as operating system, hardware platform, hostname, and MAC address will be updated, and Google Workspace-specific attributes will be added.
  • For hosts that cannot be matched with an existing runZero asset, a new asset will be created in the site specified when the integration task is set up.

runZero is able to merge existing assets with ChromeOS devices when the IP address, hostname, or MAC address overlaps. Mobile devices will be merged with existing runZero assets when the MAC address matches. Endpoint devices will be merged with existing runZero assets when the hostname or MAC address match. Google Workspace devices can also be manually merged into runZero assets using the Merge button on the Asset Inventory page.

Requirements

  • Verify that you have runZero Professional or runZero Enterprise.
  • Verify or create a new Google service account in whichever project is most suitable.
  • Create and download a key for the Google service account. Save this JSON file.
  • Verify that you have the Admin SDK and Cloud Identity APIs enabled for the project. Use the search box in the API Library to find each API and then enable it.
  • Enable domain-wide delegation in the Google Workspace console
    • Add a new API client using the unique numeric ID of service account as the Client ID
    • Enable the following OAuth scopes for this API client: 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.device.mobile.readonly,https://www.googleapis.com/auth/admin.directory.device.chromeos.readonly,https://www.googleapis.com/auth/cloud-identity.devices.readonly
    • Optionally, enter each OAuth scope individually:
    • 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.device.mobile.readonly
    • https://www.googleapis.com/auth/admin.directory.device.chromeos.readonly
    • https://www.googleapis.com/auth/cloud-identity.devices.readonly

How to set up the Google Workspace integration

These are the high-level steps to set up the Google Cloud Platform integration:

Step 1: Create a Google Workspace credential

  1. Go to the Credentials page and click Add Credential.
  2. From the Credentials type dropdown, choose Google Workspace Client Secret.
  3. Provide a name for the credential, like Google Workspace.
  4. In the Admin account email field, provide the email address of an administrator account with access to the assets, users, or groups you wish to import.
  5. If you want to import from an organization other than the one your administrator account belongs to, provide a Customer ID. By default, runZero will use the Customer ID associated with the service account. (Optional)
  6. Click Choose file to upload the service account key file you downloaded from Google Workspace.
  7. If you want other organizations to be able to use this credential, select the Make this a global credential option. Otherwise, you can configure access on a per-organization basis.
  8. Save the credential. You’re now ready to set up and activate the connection to bring in data from Google Workspace.

Step 2: Choose how to configure the Google Workspace integration

The Google Workspace integration can be configured as either a scan probe or a connector task. Scan probes gather data from integrations during scan tasks. Connector tasks run independently from either the cloud or one of your Explorers, only performing the integration sync. Configuring the integration as a scan probe is useful if you are running self-hosted runZero Enterprise and your console cannot access Google Workspace. For most situations it will be easier to set up a scheduled connection to sync your data from Google Workspace.

Step 3: Activate the Google Workspace integration

After you add your GCP credential, you’ll need to set up a connector task or scan probe to sync your data.

Step 3a: Configure the Google Workspace integration as a connector task

A connection requires you to set a schedule and choose a site. The schedule determines when the sync occurs, and the site determines where the data is organized.

  1. Activate a connection to Google Workspace. You can access all available connections from your inventory or Tasks page.
  2. Choose the credential you added earlier. If you don’t see the credential listed, make sure the credential has access to the organization you are currently in.
  3. Enter a name for the task, like Google Workspace sync.
  4. Schedule the sync. A sync can be set to run on a recurring schedule or run once. The schedule will start on the date and time you have set.
  5. To organize your assets logically, choose the site you’d like to use to add your assets to. You can choose an existing site or add them to a new site when the sync occurs. Assigning your assets to a site helps organize and group your assets.
  6. If you want to exclude assets that have not been scanned by runZero from your integration import, switch the Exclude unknown assets toggle to Yes. By default, the integration will include assets that have not been scanned by runZero.
  7. Activate the connection when you are done. The sync will run on the defined schedule. You can check the Scheduled tasks to see when the next sync will occur.

Step 3b: Configure the Google Workspace integration as a scan probe

  1. Create a new scan task or select a future or recurring scan task from your Tasks page.
  2. Add or update the scan parameters based on any additional requirements.
  3. On the Probes and SNMP tab, choose which additional probes to include, set the GoogleWorkspace toggle to Yes, and change any of the default options if needed.
  4. On the Credentials tab, set the GoogleWorkspace toggle for the credential you wish to use to Yes.
  5. Click Initialize scan to save the scan task and have it run immediately or at the scheduled time.

Step 4: View your Google Workspace assets

After a successful sync, you can go to your inventory to view your Google Workspace assets. These assets will have a Google Workspace icon listed in the Source column.

To view all your Google Workspace assets, run the following query:

source:googleworkspace

Click into each asset to see its individual attributes. runZero will show you the attributes returned by Google Workspace.

Step 4: View Google Workspace assets

After a successful sync, you can go to your inventory to view your Google Workspace assets. These assets will have a Google Workspace icon listed in the Source column.

To filter by Google Workspace assets, consider running the following queries:

Click into each asset to see its individual attributes. runZero will show you the attributes returned by Google Workspace.

Enterprise

For Enterprise users, the Google Workspace integration provides details about users and groups in addition to enriching asset inventory data. Go to Inventory > Users or Inventory > Groups to view the data provided by Google Workspace. Use the query source:googleworkspace to filter your results.