- 25 Jun 2024
- 4 Minutes to read
- Print
- DarkLight
- PDF
Google Workspace - Update User
- Updated on 25 Jun 2024
- 4 Minutes to read
- Print
- DarkLight
- PDF
Google Workspace - Update User updates the information in the Google Workspace user account for:
- Assets that match the results of the selected saved query and match the Enforcement Action Conditions, if defined or assets selected on the relevant assets page.
See Creating Enforcement Sets to learn more about adding Enforcement Actions to Enforcement Sets.
General Settings
- Enforcement Set name (required) - The name of the Enforcement Set. A default value is added by Axonius. You can change the name according to your needs.
- Add description - Add a description of the Enforcement Set. It is recommended to describe what the Enforcement Set does.
- Run action on assets matching following query (required) - Select an asset category and a query. The Enforcement Action will be run on the assets that match the query parameters.
- A query only returns results for the asset type it was created for.
- Not all asset categories are supported for all Enforcement Actions.
- See Actions supported for Activity Logs, Adapters Fetch History, and Asset Investigation modules.
- See Actions supported for Vulnerabilities.
- See Actions supported for Software.
- Action name (required) - The name of the Main action. A default value is added by Axonius. You can change the name according to your needs.
- Configure Dynamic Values - Toggle on to enter a Dynamic Value statement. See Creating Enforcement Action Dynamic Value Statements to learn more about Dynamic Value statement syntax.
- Use stored credentials from Google Workspace (G Suite) adapter - Select this option to use Google Workspace adapter credentials. When you select this option, the Select Adapter Connection dropdown is available, and you can choose which adapter connection to use for this Enforcement Action.
To use this option, you must successfully configure a Google Workspace adapter connection.
Required Fields
These fields must be configured to run the Enforcement Set.
- First Name - The user's first name.
- Last Name - The user's last name.
- Email - The user's email address.
Compute Node - The Axonius node to use when connecting to the specified host. For more details, see Connecting Additional Axonius Nodes.
Additional Fields
These fields are optional.
- Get OAuth Apps - Select this option to fetch the OAuth applications used by each user.
- Fetch Cloud Identity Devices - Select this option to fetch Cloud Identity devices.
- Fetch Chrome Browsers - Select this option to fetch Chrome browsers information.
- Fetch Calendars - Select this option to fetch users' calendars.
- SSO Provider - If your organization uses Google Workspace for SSO, you can select this check box. For more information, see Connecting your SSO Solution Provider Adapter .
Connection Parameters
When Use stored credentials from Google Workspace (G Suite) adapter is toggled Off, these fields are required:
- Email of an admin account to impersonate - The email of your Google Workspace (G Suite) admin.
- Account Profile Name - Google user name for retrieving SaaS data. https://admin.google.com/ac/accountsettings/profile
- JSON Key pair for the service account - Upload the JSON file you created for your service account. For more details, refer to Google Workspace adapter.
- Username and Password - The credentials for a user account that has the Required Permissions to fetch assets.
- Login URL - The hostname or IP address of the Google server.
- 2FA Secret Key - The secret generated in Google Workspace for setting up 2-factor authentication for the Google Workspace user created for collecting SaaS Management data.
- Proxy address - Connect the adapter to a proxy instead of directly connecting it to the domain.
- Proxy port - The port for the proxy server.
- Proxy username - The user name to use when connecting to the value supplied in Host Name or IP Address via the value supplied in Proxy address.
- Proxy password - The password to use when connecting to the server using the Proxy.
Gateway Name - Select the gateway through which to connect to perform the action.
APIs
Axonius uses the Google Workspace - Manage user accounts API.
Required Permissions
This enforcement action requires the following:
Permission for creating a user.
Entering the scope https://www.googleapis.com/auth/admin.directory.user into your Google account's Domain Wide Delegation for the Client ID used for this connection (inside the JSON file).
The Get OAuth Apps option requires addition of the following scope to your Google Workspace (G Suite) admin account: https://www.googleapis.com/auth/admin.directory.user.security
The Fetch Cloud Identity Devices option requires the following:
- Addition of the following scope to your Google Workspace (G Suite) admin account: https://www.googleapis.com/auth/cloud-identity.devices.readonly
- Enabling the Cloud Identity API.
The Fetch Chrome Browsers option requires an additional privilege to your Google Workspace (G Suite) admin account: https://www.googleapis.com/auth/admin.directory.device.chromebrowsers.readonly
The Fetch Calendars option requires the following:
An additional privilege to your Google Workspace (G Suite) admin account: https://www.googleapis.com/auth/calendar
Enabling the Cloud Identity API.
For more information on adding a privilege/scope to your Google Workspace (G Suite) admin account, refer to Configure the OAuth Scopes.
For more information on enabling the Cloud Identity API, refer to Enable Cloud API.
For more details about other Enforcement Actions available, see Action Library.