OAuth 2 Google service

Features requiring the OAuth 2 Google service

You will need to set up an OAuth 2 Google service in order to use the following features:

• Google Drive repository
• OAuth 2 authentication for enabling users to log in to Moodle with their Google account
• Google Drive converter for converting assignment submission files to PDF for teachers to annotate

OAuth 2 Google service setup

To set up an OAuth 2 client with Google, first we need to login to the Google Developers Console and create a new project.

Create a new project using the menu at the top of the page.

Create new project

Call the new project whatever you like, this name is not shown to users when they are asked to authorise this application.

Name the project

Select "credentials" from the menu on the left.

Switch to credentials page

Setup the consent screen for your application. This is where you provide the public information that is shown to users when they are asked to authorise your application. Setting a product name is the minimum information that is required, but the more information you provide here - the more confidence users will have when granting this authorisation.

Setup consent screen

Now you can create some client credentials. Switch to the credentials tab and create a new OAuth client ID.

Create an OAuth Client ID

Setup the credentials for a Web Application. The most important setting here is to set the callback URL ("Authorized redirect URI"). This must be set to "your moodle site url + /admin/oauth2callback.php". If your moodle site was accessible at https://lemon.edu/ then this callback URL should be set to https://lemon.edu/admin/oauth2callback.php. Make sure this box has saved properly.

Set the callback URL

When you have saved the information on this page, Google will give you the client ID and client secret that you need to enter into Moodle.

Got my secrets!

Finally we have to enable the Drive API (if we want to use the google drive repository or file converter plugins).

View the Library tab

Select Drive API

Enable the API

App verification

NOTE: If you are just using this for document conversion you will not need to verify (as it only uses one account). You will, however, need to verify your ownership of your domain (see, [1])

The Google Drive repository and Google Drive converter also require the app to be verified by completing the OAuth Developer Verification Form. The list of scopes that Moodle requires are: openid profile email https://www.googleapis.com/auth/drive.

See the discussion Google Drive Repository and Moodle 3.3.1 for more details.