Google Drive

​

Before you begin

• Use a Google account that can manage the Google Cloud project. It does not need access to the Drive content that users will import.
• Know the public URL of your Zylon instance, for example https://zylon.company.com.
• Keep the OAuth client secret in a secure secret store. Do not commit it to source control. The Picker API key is used by the browser, so restrict it to the required APIs and, where applicable, your Zylon origin.

​

Create or select a Google Cloud project

1. Open the Google Cloud console.
2. Select an existing project or create a new project for the integration.
3. Record the Project number from the project dashboard. Zylon uses this as the Picker App ID.

​

Enable the Google APIs

1. In the Google Cloud console, go to APIs & Services → Library.
2. Search for and enable Google Drive API.
3. Search for and enable Google Picker API.

​

Create and restrict an API key

1. Go to APIs & Services → Credentials.
2. Select Create credentials → API key.
3. Copy the key; it is the value for Zylon’s apiKey setting.
4. Open the new key and, under API restrictions, select Restrict key.
5. Select Google Drive API and Google Picker API, then save the key.

​

Configure the OAuth consent screen and data access

1. In the Google Cloud console, open Google Auth platform. Complete the required Branding and Audience settings for your organization.
2. Open Data Access and select Add or remove scopes.
3. Add the following scopes, then save the changes.

​

Create an OAuth client

1. In Google Auth platform, open Clients.
2. Select Create client and choose Web application as the application type.
3. Give the client a meaningful name, such as Zylon Google Drive.
4. Under Authorized redirect URIs, add the following URL, replacing the domain with your Zylon instance URL:

https://{your-zylon-domain}/api/app/integration/googledrive/callback

5. Create the client.
6. Copy the Client ID and Client secret. You will use them as clientId and clientSecret in the Zylon configuration.

​

Configure Zylon

integration:
  googleDrive:
    enabled: true
    clientId: "{Google OAuth client ID}"
    clientSecret: "{Google OAuth client secret}"
    redirectUri: "https://{your-zylon-domain}/api/app/integration/googledrive/callback"
    apiKey: "{Google API key}"
    appId: "{Google Cloud project number}"

integration:
  googleDrive:
    enabled: true
    clientId: "{Google OAuth client ID}"
    clientSecret: "{Google OAuth client secret}"
    redirectUri: "https://{your-zylon-domain}/api/app/integration/googledrive/callback"
    apiKey: "{Google API key}"
    appId: "{Google Cloud project number}"

sudo zylon-cli sync

​

Troubleshooting

​

The Google Drive option is unavailable or the picker closes immediately

• Confirm that integration.googleDrive.enabled is true.
• Confirm that apiKey and appId are configured. The Picker requires both values.
• Confirm that the Google Drive API and Google Picker API are enabled in the same Google Cloud project.

​

Google sign-in reports a redirect URI error

• Verify that the Authorized redirect URI is exactly the same as redirectUri in the Zylon configuration.
• Confirm that the domain is the public HTTPS domain used to access Zylon.

​

A user cannot see or import a Drive item

• Confirm that the user signs in with the Google account that can access the item.
• Confirm that the consent screen includes all scopes listed in Configure the OAuth consent screen and data access.