Skip to main content

CollectorsCloud Collectors Administration Guide

Table of Contents

Prerequisites to Configure the Google Workspace Cloud Collector

Before you configure the Google Workspace Cloud Collector you must complete the following prerequisites:

Authorize the Google Workspace Cloud Collector to Retrieve Events

For Service-Account authentication, a G Suite administrator will need to create a file (called Service-Credentials-Json) that authorizes the Google Workspace Cloud Collector (or anyone else who possess it) to communicate with the G Suite account and retrieve relevant logs, events and data for the security monitoring.

To create the Service-Credentials-Json JSON file, ask the G Suite administrator to follow the instructions mentioned here Create a Service-Credentials-Json File for the Google Workspace Cloud Collector .

Use your preferred secured method of transport to send the JSON file to the Exabeam Cloud Collectors administrator to configure the Google Workspace Cloud Collector.

Create a Service-Credentials-Json File for the Google Workspace Cloud Collector

If you use the service-account authentication method, you need to set up communication between the cloud collector and the G-Suite account. To facilitate communication and enable to retrieve audit events, you must create a service-credentials-json file.

Note

To use the service account you are required to have a Domain-Wide Delegation of Authority. Since you need this delegation of authority to read reports about admin activity, the user, whose authority is being used, must have super-admin privileges to view admin report activity and read user and groups information. The service account is still bound by the permissions granted and thus cannot perform any action other than read access on the specified scopes.

To create the JSON file, review the video or use the following workflow:

  1. Log in to the Google Developers Console with an account that has super-admin permissions.

  2. Create a new project by doing one of the following:

    • If you haven't used the Developers Console before, agree to the Google Cloud Platform Terms of Service. Then, click Create a project.

    • At the top of the screen next to your most recent project name, click the down arrow to open your projects list. Then, Create a new project.

  3. Enter a project name and click Create.

    g_suite_creating_a_project_in_the_developer_portal.png
  4. Enable the Admin SDK API.

    Each project uses its own set of APIs. For the Google Workspace Cloud Collector to be able to use the service-account authentication method, you must enable the Admin SDK API to the just added project.

    1. ENABLE APIS AND SERVICES in the project context to display the API Library Search.

      g_suite_project_added_API_enablment_search_screen.png
    2. In the search field, enter Admin SDK API.

      g_suite_project_added_API_enablment_search_for_admin_api.png
  5. Create the service account.

    1. In the top-left corner of the console, click Menu.

    2. Click IAM & Admin.

    3. Click Create service account and in the Service account name field, enter a name for the service account.

    4. Select the Furnish a new private key box and ensure the key type is set to JSON.

    5. Select the Enable Domain-wide Delegation box and enter a name in the Product name for the consent screen field.

    6. Click Create. You'll see a message that the service account JSON file has been downloaded to your computer.

    7. Encrypt and send the JSON file to Exabeam Support using a secure transport method.

    8. Click Close.

    9. In the Options column, click the View Client ID link for the service account you have just created.

    10. Copy the Client ID value. You will need this later.

  6. Set the needed API permission scope.

    1. Open the admin console.

    2. Go to Security > Advanced settings > Manage API client access.

    3. In the upper row, in the Client Name field, enter:

      • Under Client Name, insert the Client ID saved during the previous step (you can also see it in the JSON file created under client_id key).

      • Under the One or More API Scopes field, enter the below API scopes (copy and paste to keep the comma separation in place).

        For Exabeam to only read events:

        https://www.googleapis.com/auth/admin.directory.group.readonly,https://www.googleapis.com/auth/admin.directory.user.readonly,https://www.googleapis.com/auth/admin.directory.rolemanagement.readonly,https://www.googleapis.com/auth/admin.directory.orgunit.readonly,https://www.googleapis.com/auth/admin.reports.audit.readonly,https://www.googleapis.com/auth/admin.reports.usage.readonly,https://www.googleapis.com/auth/apps.alerts

        You should see a screen similar to the below:

        g_suite_api_scopes_set_for_new_client_ID.png