This is the multi-page printable view of this section. Click here to print.

Return to the regular view of this page.

Google Workspace

    Samurai [Local] CollectorSamurai [Cloud] CollectorSamurai [Cloud Native] Collector
    Picture1.svg

    To complete this Integration you will need to perform steps in both Google Workspace and the Samurai MDR portal.

    The Google Workspace integration leverages two APIs which are part of the Admin SDK API

    1. Google Workspace Reports API
    2. Google Workspace Alert Center API

    Follow the steps below:

    1. From Google Workspace

    2. From the Samurai MDR portal

    Enable the Admin SDK API

    Follow the Google API Console Help documentation:

    mceclip0.png A Google API Console project is required and will be created during the steps.

    Ensure you login to the Google Console as a super administrator and use the following parameters when completing the steps:

    Documentation StepField NameParameter
    2Project NameAnything you want but we recommend “SamuraiAPI”
    2OrganizationThe name of your organization
    2LocationAnything you want
    4API LibrarySelect and enable against the project created in Step 2:

    “Admin SDK API”

    “Google Workspace Alert Center API”

    mceclip0.png Review the API Console Help pages if you require more information on Google APIs.

    Create a service account

    Follow the steps outlined within the Google documentation:

    mceclip0.png Ensure you have the Project selected that you created in Enable the Admin SDK API

    mceclip0.png Ignore the optional steps 4 and 6 when creating the service account.

    Use the following parameters when completing the steps:

    Documentation StepField NameParameter
    3Service Account NameAnything you want but we recommend “SamuraiAPI”
    3Service Account IDAnything you want but we recommend “SamuraiAPI”
    3Service Account DescriptionAnything you want but we recommend “SamuraiAPI”

    mceclip0.png Take note of the Service Account email address in Step 3 as it will be needed when you Complete the Google Workspace integration

    Create credentials for the service account

    Follow the steps outlined within the Google documentation:

    Documentation StepField NameParameter
    2ProjectSelect the project created in Enable the Admin SDK API
    2Service AccountSelect the service account you created in Create a service account
    4Key TypeEnsure “JSON” is selected.

    mceclip0.png Download the json file as it will be required when you Complete the Google Workspace integration

    Delegate domain-wide authority to the service account

    Follow the steps outlined within the Google documentation:

    mceclip0.png Ensure you login with a super admin account and take note of the associated email address as you will need in when you Complete the Google Workspace integration

    Use the following parameters when completing the steps:

    Documentation StepField NameParameter
    2Service AccounrtEnsure you select the service account created in Create a service account
    5eOAuth scopeshttps://www.googleapis.com/auth/admin.reports.audit.readonly
    https://www.googleapis.com/auth/admin.reports.usage.readonly
    https://www.googleapis.com/auth/apps.alerts

    Complete the Google Workspace integration

    You will need:

    1. Login to the Samurai MDR portal
    2. Click Telemetry and select Integrations from the main menu
    3. Select Create
    4. Locate and click Google Workspace 
    5. Click Next (we leverage a Samurai Cloud Collector)
    6. Enter a Name of Integration
    7. Enter a Description (Optional)
    8. Enter your Service Account JSON (copy and paste from the json file you downloaded)
    9. Enter your Domain-Wide delegation account (the admin account email used for domain-wide delegation)
    10. Click Finish

    mceclip0.png For general information on Integrations refer to the Integrations article.

    Our Integration guide was accurate at the time of writing but vendors change things frequently! If you find errors or anything is outdated, let us know by raising a request in the Samurai MDR application and we shall get it updated.