Google Drive #
For Google Drive we work with a Google service account provided by uman. During the set-up process you will be given a service account email address and service account identifier that is generated on uman side.
It is required to have a Google Workspace in order for uman to be able to index content. The workspace context is needed for consistently adopting the permissions.
Subsequently you need to grant the service account access to the desired Google Shared Drive folders (
viewer access is enough).
It is important to note that access needs to be granted on Shared Drive level, and not a subfolder of a Shared Drive.
Adding the service account to the Shared Drive will grant the following permissions implicitly:
https://www.googleapis.com/auth/drive.readonly: required to read all Google Drive folders within the Shared Drive and download files that need to be indexed in uman.
https://www.googleapis.com/auth/drive.activity.readonly: required to read activities related to those files
Next to adding the service account to the desired Shared Drives, you need to grant the service account the following domain-wide scopes:
https://www.googleapis.com/auth/admin.directory.user.readonly: required to read all users, relevant for the metadata of files and permissions.
https://www.googleapis.com/auth/admin.directory.group.member.readonly: required to read all groups and its users in order to mirror the Google Drive permissions.
For instructions on how to grant these domain-wide delegation, check the Google docs.
Setup process #
Please follow the steps below:
- Retrieve the service account email address and identifier from the uman team
- Grant the service account
vieweraccess to the desired Shared Drives
- Grant the service account the aforementioned domain-wide scopes
- Let the uman team know that the steps above have happened successfully and provide an email address of an administrator (at least ‘User Management Admin’ and ‘Groups Reader’ roles) that uman can use to impersonate the admin scope calls