Axonius Documentation
Start typing to search…

Google Workspace - Add Users to Group

Google Workspace - Add Users to Group adds the users to a Google Workspace group for:

  • Assets returned by the selected query or assets selected on the relevant asset page.

See Creating Enforcement Sets to learn more about adding Enforcement Actions to Enforcement Sets.

📘

Note:

Required Fields

These fields must be configured to run the Enforcement Set.

  • Action name - The name of this Enforcement Action. The system sets a default name. You can change the name.
  • 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 credentials from the adapter connection. By default, the first connection is selected.

    • When you select this option, the Select Adapter Connection drop-down becomes available. Select the adapter connection to use for this Enforcement Action.

📘

Note

To use this option, you must successfully configure a Google Workspace adapter connection.

:::

  • Group email address - The email address of the Google Workspace group to which the member will be added.

  • Compute Node - The Axonius node to use when connecting to the specified host. For more details, see Working with Axonius Compute Nodes.


Additional Fields

These fields are optional.

  • Email of an admin account to impersonate - The email of your Google Workspace (G Suite) admin.
  • 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.
💡

Connection and Credentials

When Use stored credentials from the adapter is toggled off, some of the connection fields below are required to create the connection, while other fields are optional.

  • Member role - The role for the member in the Google Workspace group, either 'MEMBER', 'MANAGER' or 'OWNER'.

  • Subscription (Delivery Settings) - Select the message delivery method (See Google documentation for details):

    • Default
    • Each Mail (All Mail)
    • Abridged (Daily)
    • Digest
    • Disabled
    • No Email (None)

  • Gateway Name - Select the Gateway through which to connect to perform the action.

APIs

Axonius uses the Google Workspace - Directory API: Group Members.

Required Permissions

This action requires permission to add a user to a group.

Also, this action requires that you enter the following scope in your Google account's Domain Wide Delegation for the Client ID used for this connection (inside the JSON file): 'https://www.googleapis.com/auth/admin.directory.group'

For more details about other Enforcement Actions available, see Action Library.

Updated about 17 hours ago