Python boilerplate for service account oauth setup to return data from a Google API

README.md

Prerequisites

For a more detailed version of the steps below visit: https://developers.google.com/admin-sdk/directory/v1/guides/delegation

• Enable the necessary APIs (calendar, drive, gmail, etc.) in Cloud Console
• Create a service account, download the json key file, and enable domain wide delegation (DwD)
• Determine the required scopes (calendar readonly, drive read/write, etc.)
• In the G Suite console, an admin authorizes the service account (client ID) with the specified scopes
• The admin also identifies an account — with proper admin privileges — that the service account will impersonate (when you want to access user's data without manual authorization from the user)

With the above in place, you or another developer, who has the json key file, can run the python code.

For documentation on how to do with Java see: https://developers.google.com/api-client-library/java/google-api-java-client/oauth2#service_accounts

Errors

"unauthorized_client: Client is unauthorized to retrieve access tokens using this method."

Most likely means the service account hasn't been authorized in the G Suite console properly. Check that the scopes are the same between the app and G Suite.

"Not Authorized to access this resource/api"

The delegate user account doesn't have proper privileges to access the requested resource. https://stackoverflow.com/questions/42784640/client-is-unauthorized-to-retrieve-access-tokens-using-this-method-gmail-api-c-s

Gmail API returns 403 error code and “Delegation denied for...”

https://stackoverflow.com/questions/26135310/gmail-api-returns-403-error-code-and-delegation-denied-for-user-email

google-admin-directory.py

# pip install --upgrade google-api-python-client google-auth google-auth-httplib2
from google.oauth2 import service_account
import googleapiclient.discovery


SCOPES = ['https://www.googleapis.com/auth/admin.directory.user.readonly']
SERVICE_ACCOUNT_FILE = 'credentials.json'

DELEGATE='<[email protected]>'  # Service account will impersonate this user. Must have proper admin privileges in G Suite.
TARGET='<domain.com>'  # Service account wants to access data from this.

credentials = service_account.Credentials.from_service_account_file(
        SERVICE_ACCOUNT_FILE, scopes=SCOPES)
credentials_delegated = credentials.with_subject(DELEGATE)

service = googleapiclient.discovery.build('admin', 'directory_v1', credentials=credentials_delegated)
response = service.users().list(domain=TARGET).execute()

print(response)

google-calendar.py

# pip install --upgrade google-api-python-client google-auth google-auth-httplib2
from google.oauth2 import service_account
import googleapiclient.discovery


SCOPES = ['https://www.googleapis.com/auth/calendar.readonly']
SERVICE_ACCOUNT_FILE = 'credentials.json'  # path to json key file generated after creating a service account with DwD enabled.
TARGET='<[email protected]>'  # Service account wants to access data from this.

credentials = service_account.Credentials.from_service_account_file(
        SERVICE_ACCOUNT_FILE, scopes=SCOPES)

service = googleapiclient.discovery.build('calendar', 'v3', credentials=credentials)
response = service.calendars().get(calendarId=TARGET).execute()

print(response)

google-drive.py

# pip install --upgrade google-api-python-client google-auth google-auth-httplib2
from google.oauth2 import service_account
import googleapiclient.discovery


SCOPES = ['https://www.googleapis.com/auth/drive.readonly']
SERVICE_ACCOUNT_FILE = 'credentials.json'

DELEGATE='<[email protected]>'  # Service account will impersonate this user. Must have proper admin privileges in G Suite.

credentials = service_account.Credentials.from_service_account_file(
        SERVICE_ACCOUNT_FILE, scopes=SCOPES)
credentials_delegated = credentials.with_subject(DELEGATE)

service = googleapiclient.discovery.build('drive', 'v3', credentials=credentials_delegated)
response = service.files().list(corpus='domain').execute()

print(response)

Thanks for this code. google-admin-directory.py

I have been struggling getting the quickstarts working with the admin sdk and a service account. Do I always need to have a delegate ? The docs "vaguely" suggest all I need is the secrets file and then get an access token using that.

Very helpful to get started with the admin-api with service accounts. Thank you.

saved my time