- 22 May 2023
- 4 Minutes to read
- Print
- DarkLight
- PDF
Google Workspace (G Suite)
- Updated on 22 May 2023
- 4 Minutes to read
- Print
- DarkLight
- PDF
Google Workspace (formerly G Suite) is a collection of cloud computing, productivity, collaboration, device, user, and data management tools developed by Google.
Types of Assets Fetched
This adapter fetches the following types of assets:
- Devices
- Users
Prerequisites
To connect Axonius to Google Workspace you need to:
Parameters
- Email of an admin account to impersonate (required) – The email of your Google Workspace (G Suite) admin.
- JSON Key pair for the service account (required) – Upload the JSON file you have created for your service account. For more details, see the sections below.
- Get OAuth Apps - Select to fetch the OAuth applications used by each user.
- Fetch Cloud Identity Devices - Select whether to fetch Cloud Identity devices.
- If enabled, the connection for this adapter will also fetch Cloud Identity devices.
- If disabled, the connection for this adapter will not fetch Cloud Identity devices.
Note:Fetching Cloud Identity devices requires:
- Cloud Identity API enabled.
- Additional privilege to your Google Workspace (G Suite) admin account: https://www.googleapis.com/auth/cloud-identity.devices.readonly
- Fetch Chrome Browsers - Select whether to fetch Chrome browsers information.
- If enabled, the connection for this adapter will fetch information about Chrome browsers.
- If disabled, the connection for this adapter will not fetch information about Chrome browsers.
Note:Fetching Chrome browsers information requires an additional privilege to your Google Workspace (G Suite) admin account: https://www.googleapis.com/auth/admin.directory.device.chromebrowsers.readonly
- Fetch Calendars - Select whether to fetch users' calendars.
- To learn more about common adapter connection parameters and buttons, see Adding a New Adapter Connection.
Advanced Settings
Advanced settings can either apply for all connections for this adapter, or you can set different advanced settings and/or different scheduling for a specific connection, refer to Advanced Configuration for Adapters.
Fetch MDM devices (required, default: true) - Select this option to fetch Mobile devices and ChromeOS devices from Google Workspace.
Cloud Identity prefer device with recent last seen if duplicated asset name - Select whether in cases that more than one device with the same asset name is fetched from the Cloud Identify, the device with the most recent last seen will be saved under that asset name.
- If enabled, all connections for this adapter will not save all devices with the same asset name, only the device with the most recent last seen.
- If disabled, all connections for this adapter will save all devices with the same asset names.
Fetch user groups - Select whether to fetch user group memberships for each user from Google Workspace.
- If enabled, all connections for this adapter will fetch user group memberships for each user.
- If disabled, all connections for this adapter will not fetch user group memberships for each user.
Note:Fetching user group memberships requires an additional privilege to your Google Workspace (G Suite) admin account: https://www.googleapis.com/auth/admin.directory.group.readonly
For details on general advanced settings under the Adapter Configuration tab, see Adapter Advanced Settings.
4. Ignore Cloud Identity devices without serial - Select whether to ignore devices coming from Cloud Identity without Serial Numbers.
5. Do not fetch disabled User Accounts (optional) - Select whether to exclude disabled user accounts from the fetch.
Enabling Cloud APIs
To enable the Cloud APIs
Go to the Google Cloud Console and select the project that you want Axonius to connect to.
Go to APIs & Services -> Dashboard.
Verify the following APIs are listed:
- Admin SDK API - Required for the basic data fetch.
- Cloud Identity API - Required only to fetch Cloud Identity devices.
- Google Calendar API - Required to fetch Google Calendar data.
If Admin SDK does not appear in the list, click Enable APIs and Services at the top of the screen, search for Admin SDK. Then click Enable.
Creating a Service Account
To create a service account
Go to the Google Cloud Console and select the project that you want to create the service account in.
Go to IAM & admin -> Service accounts.
Click Create Service Account and fill in the details.
In the next tab, continue without setting any roles.
Click Create Key and create a JSON type key:
Your JSON key will be downloaded. Finish creating the user and go back to the service accounts screen.
Click on the newly created service account and then click the Edit link at the top.
Click Show Domain-Wide Delegation and select Enable G Suite Domain-wide Delegation.
Click Save to finalize the changes.
Go back to the service accounts list. You can now view the client-id for the service account. Copy it.
Open the G Suite Admin Panel and search for Manage API Client Access, then open it.
In the client name field, specify the client id of your service account. In the One or More API Scopes section, specify these scopes:
- Required scopes:
https://www.googleapis.com/auth/admin.directory.device.mobile.readonly,https://www.googleapis.com/auth/admin.directory.user.readonly,https://www.googleapis.com/auth/admin.directory.device.chromeos.readonly
- Additional scope to fetch OAuth applications:
https://www.googleapis.com/auth/admin.directory.user.security
- Additional scope to fetch Cloud Identity devices:
https://www.googleapis.com/auth/cloud-identity.devices.readonly
- Additional scope to fetch Chrome browsers information:
https://www.googleapis.com/auth/admin.directory.device.chromebrowsers.readonly
- Additional scope to fetch user group memberships:
https://www.googleapis.com/auth/admin.directory.group.readonly
- Additional scope to fetch Google Calendar:
https://www.googleapis.com/auth/calendar
Click Authorize.