Begin Scanning a Gmail App

Add your Gmail app to SaaS Security API to begin scanning and monitoring assets for possible security risks.
To connect a Gmail app to SaaS Security API and begin scanning assets, you need to:
  • Ensure that you have a Google admin account with Super Admin role.
  • Add the Google admin account to SaaS Security API and assign a Super Admin role.
  • Add the Gmail app to Google Marketplace and SaaS Security API.
  • Grant Gmail API access to SaaS Security API.
For information on which automated remediation capabilities SaaS Security API supports with Gmail, refer to Supported Applications with Remediation.

Prepare To Add Gmail App

Google’s default Super Admin role provides the necessary communication between SaaS Security API and the Gmail app.
  • Read, write, and relocate assets in the app.
  • API access. API access provides visibility into the assets in Gmail and allows SaaS Security API to monitor the sharing of assets.
  1. Verify that your Google administrator account is assigned Super Admin role.
  2. Google administrator account’s domain matches the existing domain on SaaS Security API.
  3. (
    Recommended
    ) Add your Gmail domain as an internal domain.
  4. Log in to Google Marketplace using an admin account with Super Admin role permissions.
    1. Go to https://gsuite.google.com/marketplace and log out of Google Marketplace to ensure that you are not logged in as a user other than an account with Super Admin role permissions.
    2. Log in again to Google Marketplace using an account that has Super Admin role permissions.
  5. Add the email address of the Google administrator to SaaS Security API and assign a Super Admin role.
  6. Next Step
    : Proceed to Add Gmail App.

Add Gmail App

In order for SaaS Security API to scan assets, you must consent to specific permissions during the course of adding the Gmail app.
  1. From the
    Dashboard
    , select
    Add a Cloud App
    .
  2. Select
    Gmail
    to launch the install.
  3. Before you begin
    : As indicated in the on-screen instructions in Step 1, Prepare To Add Gmail App.
  4. Follow the on-screen instructions in Step 2:
    Go to Google Marketplace
    . Afterward, the
    Domain Install
    button is replaced by a disabled
    Uninstall
    button with a message that reads
    Please uninstall app for domain in Admin Console
    . This behavior is expected.
    1. Select
      Domain Install
      on the Google Marketplace page.
      Do not go to the link provided. Doing so aborts the onboarding process. If you inadvertently do so, simply repeat the process starting with launching the install.
    2. Click
      Continue
      to proceed with the
      Domain wide install
      process.
    3. Review and
      Accept
      the requested permissions.
      SaaS Security API requires these permissions to scan your assets on Gmail. A new browser window opens in the foreground.
    4. Click
      Done
      .
  5. Follow the on-screen instructions in Step 3:
    Connect to Gmail Account
    .
    After you enter the Gmail admin email, you are redirected to
    Cloud Apps and Scan Settings
    on SaaS Security API. A message displays in a banner and the Gmail:
    App installed
    .
    SaaS Security API adds the new Gmail app to the Cloud Apps list as
    Gmail
     n, where n is the number of Gmail app instances that you connected to SaaS Security API. For example, if you added one Gmail app, the name displays as
    Gmail 1
    . You’ll specify a descriptive name soon.
    Congratulations—you’ve completed the onboarding process!
  6. Next Step
    : Proceed to Identify Risks and begin scanning your assets.

Identify Risks

When you add a new cloud app and enable scanning, SaaS Security API automatically scans the cloud app against the default data patterns and displays the match occurrences. You can take action now to improve your scan results and identify risks.
  1. Start scanning the new Gmail app for risks.
  2. During the discovery phase, SaaS Security API scans files and matches them against enabled default policy rules.
    Verify that your default policy rules are effective. If the results don’t capture all risks or you see false positives, proceed to the next step.
  3. (
    Optional
    ) Add new policy rules.
    Consider the business use of your app, then identify risks unique to your enterprise. As necessary, add new:
  4. (
    Optional
    ) Configure or edit a data pattern.
    You can Configure Data Patterns to identify specific strings of text, characters, words, or patterns to make it possible to find all instances of text that match a data pattern you specify.
  5. Next Step
    : Proceed to Customize Gmail App and Fix Gmail App Onboarding Issues, if necessary.

Customize Gmail App

If you plan to manage more than one instance of Gmail app, consider differentiating your instances.
  1. (
    Optional
    ) Give a descriptive name to this app instance.
    1. Select the Gmail n link on the Cloud Apps list.
    2. Enter a descriptive
      Name
      .
    3. Click
      Done
      to save your changes.
  2. Next Step
    : Proceed to Identify Risks.

Fix Gmail App Onboarding Issues

The most common issues related to onboarding a Gmail app are as follows:
Symptom
Explanation
Solution
When you click
Connect to Gmail Account
(Step 3 of Install page), you receive an authentication error.
The Google account doesn’t have sufficient permissions to authenticate and access all the assets within Gmail.
Make sure your Google account is an administrator with default super admin role or applicable custom role with the permission outlined in Prepare To Add Gmail App.
When you click
Connect to Gmail Account
(Step 3 of Install page), you receive a login error:
This email must be added as a Super Admin
The Google account doesn’t have an administrator account in SaaS Security API.
Make sure your Google account is super admin on SaaS Security API as outlined in Add Gmail App.
.
When you click
Connect to Gmail Account
(Step 3 of Install page), you’re redirected to a product landing page and the Gmail app doesn’t display in the Cloud Apps list.
Cached files are preventing the correct redirect.
Do not log out of SaaS Security API. Instead, open SaaS Security API in an incognito window. Repeat relaunch the Install page and click on
Connect to Gmail Account
(Step 3) again. The Gmail app now appears in the Cloud app list.
When click on
Go to Google Marketplace
(Step 2 of Install page), an
Please uninstall app for domain in Admin Console
message displays.
This usually occurs if you previously installed the app and deleted it from SaaS Security API but did not delete it from Google Marketplace.
Delete the app from the Google Marketplace, then you’ll be able to Add Gmail App in SaaS Security API.
This problem occurs if you complete Step 2 of Install page and either abort your install or forget to click
Connect to Google Drive Account
(Step 3 of Install page).
If the Google Marketplace page is open in the same browser and session that you used when you initially added the Gmail app, simply click
Connect to Gmail Account
.
Otherwise, delete the Gmail app from the Google Marketplace and repeat the Gmail app onboarding process in SaaS Security API.

Recommended For You