Audience
This guide is for Google Drive administrators who want to configure BRYTER integration with Google Drive.
Please note that this is a premium feature which needs to be enabled by your dedicated Customer Success Manager. For further information, please reach out to your BRYTER Customer Success Manager or support@bryter.io. Additional pricing may apply.
Before you start
Users will require the following:
- A Google Cloud Platform (GCP) application with the Google Drive API enabled.
- A service account on the GCP application, with roles that allow it to list create and update files and folders, and to read and update file fields.
Known limitations
- If the private-key is corrupted it will be rejected by Google. We currently sanitize the value to fix issues with \n characters that have been replaced or escaped.
- We do not know which roles the Google Drive administrator must grant to the service account.
- If you set the folder ID to root we do not know how to configure permissions for the service account.
- Although we use service account keys, Google’s documentation states ‘User-managed keys are extremely powerful credentials, and they can represent a security risk if they are not managed correctly.’
The Admin Console
This image illustrates the Admin Console’s Integrations page, where you can configure integrations installed in the Catalog.
To obtain the following secrets & parameters you will need to download the service account key file from the GCP console, following the instructions in Create and manage service account keys. The resulting service account key file contains values of most of the following parameters and secrets.
Parameters
Name |
Description |
Example value |
folder-id | A string ID of the folder to use as the root folder for this integration. Use root for the default root folder. | 1Tvyi6imYDRDZOXJLEsqoTWpiFxuEjB6T |
project-id | From the service account key file | example-project-137414 |
client-id | From the service account key file | 612568647752061775734 |
client-email | From the service account key file | example@example-project-137414.iam.gserviceaccount.com |
client-x509-cert-url | From the service account key file | https://www.googleapis.com/robot/v1/metadata/x509/example%40example-project-137414.iam.gserviceaccount.com |
To find your folder-id:
- In your Google Drive instance, create a new folder for testing.
- Share the folder with the service account identified in the client-email parameter.
- Grant the service account editor access.
- Find the folder ID by opening it in Google Drive and copying the last part of the URL.
Secrets
Name |
Description |
Example value |
private-key-id | From the service account key file | |
private-key | From the service account key file |