Note: You are currently viewing documentation for Moodle 3.4. Up-to-date documentation for the latest stable version of Moodle is likely available here: Google OAuth 2.0 setup.

Google OAuth 2.0 setup: Difference between revisions

From MoodleDocs
Main page ► Managing content ► Repositories ► Google OAuth 2.0 setup
Repositories
No edit summary
(→‎Registering with Google: enabling the Drive API)
 
(38 intermediate revisions by 7 users not shown)
Line 1: Line 1:
Prior to Moodle 2.3, Google Docs and Picasa repository plugins and portfolio plugins could be used without any configuration or registration with Google. In April 2012, [http://googledevelopers.blogspot.com.au/2012/04/changes-to-deprecation-policies-and-api.html Google Announced] to web application developers that they would be deprecated the service which Moodle was using to communicate with Google and strongly advised developers to move away from it. As a response to this change with Google's service, Moodle switched to use a new system for communicating with Google called 'OAuth 2.0', starting with Moodle 2.3. The OAuth 2.0 system providers and a better security system and more friendly experience to Moodle users, though it requires some additional configuration in Moodle.
{{Repositories}}
''Note: This page contains information for site administrators only.''


==Registering with Google==
==Registering with Google==
Each Moodle site now needs to be registered with Google in order to use the Google Docs or Picasa plugins. The following will guide you through the process of registering with Google.


# You will need to be signed into a google account
Each Moodle site  needs to be registered with Google i.e. have a Google Developers Console project in order to use the Google Drive, Docs or Picasa plugins. As part of the registration process, you will need to enter an authorized redirect URI (something like <nowiki>http://yourmoodlesite.org/admin/oauth2callback.php</nowiki>) which is provided on all Google Drive, Docs and Picasa plugins configuration pages in Moodle, such as ''Site administration > Plugins > Repositories > Google Drive''.
# Visit the [Google API's Console https://code.google.com/apis/console#access]
 
# You will be asked to create a project if this is your first time using this form. [[File:google_oauth1.png]]
To create a Google Developers Console project:
# You need to click the button marked 'Create an OAuth 2.0 client ID..' [[File:google_oauth2.png]]
 
# You will be asked to enter branding information including a 'Product name' and 'Product logo'. By providing a descriptive name and link to distinct image then your users will know they are signing into the correct place. [[File:google_oauth3.png]
# Go to the [https://console.developers.google.com/ Google Developers Console] and sign in to your Google account.
# Next you will be asked for 'Client ID Settings'  
# Follow the instructions provided in the Google Developers doc [https://developers.google.com/identity/sign-in/web/devconsole-project Creating a Google Developers Console project and client ID].
## For Application type, select 'Web application'
# When creating a new Client ID
## Next to 'Your site or hostname' click '(more options)'
#* In the Application type section of the dialog, select Web application.
## In 'Authorized Redirect URIs' enter the URL which was provided in your Moodle settings page. (usually http://yourmoodle/admin/oauth2callback.php)
#* Leave the Authorized JavaScript origins field empty and in the Authorized redirect URI field, enter the URL from your site.
## In 'Authorized JavaScript Origins' leave the field blank [[File:google_oauth4.png]
 
# Click 'Create client ID'
Tip: If you have more than one Moodle site to register with Google, you can add an authorized redirect URI for each site. The same name and logo would then be displayed on the authorisation screen for each Moodle site.
# Your site is now registered with Google and you will be presented with your details. [[File:google_oauth5.png]
 
# Enter the 'Client ID' and 'Client secret' provided into your Moodle settings page
You will also need to enable the Drive API:
 
# In Google API manager, under Google Apps APIs, follow the link 'Drive API'.
# Click the button to enable it.
 
==Configuring the Google Drive and Picasa repositories==
 
# Go to ''Administration > Site administration > Plugins > Repositories > Manage Repositories''
# Activate the Google Drive and/or Picasa repositories by selecting 'Enable and visible' in the dropdown menu
# Configure each repository by entering the client ID and secret. Make sure you don't include any white space in the text boxes!
# Save changes
 
==Configuring the Google Drive and Picasa portfolios==
 
# Go to ''Administration > Site administration > Plugins > Portfolios > Manage Portfolios''
# Activate the Google Drive and/or Picasa portfolios by selecting 'Enable and visible' in the dropdown menu
# Configure each portfolio by entering the client ID and secret
# Save changes
 
Once configured, Google will present Moodle users with a nice authorisation screen with your Moodle site name and logo for your users to authorise.
 
[[Category:Portfolios]]
[[Category:Site administration]]
 
[[es:Configuración de Google OAuth 2.0]]

Latest revision as of 13:02, 18 April 2016

Note: This page contains information for site administrators only.

Registering with Google

Each Moodle site needs to be registered with Google i.e. have a Google Developers Console project in order to use the Google Drive, Docs or Picasa plugins. As part of the registration process, you will need to enter an authorized redirect URI (something like http://yourmoodlesite.org/admin/oauth2callback.php) which is provided on all Google Drive, Docs and Picasa plugins configuration pages in Moodle, such as Site administration > Plugins > Repositories > Google Drive.

To create a Google Developers Console project:

  1. Go to the Google Developers Console and sign in to your Google account.
  2. Follow the instructions provided in the Google Developers doc Creating a Google Developers Console project and client ID.
  3. When creating a new Client ID
    • In the Application type section of the dialog, select Web application.
    • Leave the Authorized JavaScript origins field empty and in the Authorized redirect URI field, enter the URL from your site.

Tip: If you have more than one Moodle site to register with Google, you can add an authorized redirect URI for each site. The same name and logo would then be displayed on the authorisation screen for each Moodle site.

You will also need to enable the Drive API:

  1. In Google API manager, under Google Apps APIs, follow the link 'Drive API'.
  2. Click the button to enable it.

Configuring the Google Drive and Picasa repositories

  1. Go to Administration > Site administration > Plugins > Repositories > Manage Repositories
  2. Activate the Google Drive and/or Picasa repositories by selecting 'Enable and visible' in the dropdown menu
  3. Configure each repository by entering the client ID and secret. Make sure you don't include any white space in the text boxes!
  4. Save changes

Configuring the Google Drive and Picasa portfolios

  1. Go to Administration > Site administration > Plugins > Portfolios > Manage Portfolios
  2. Activate the Google Drive and/or Picasa portfolios by selecting 'Enable and visible' in the dropdown menu
  3. Configure each portfolio by entering the client ID and secret
  4. Save changes

Once configured, Google will present Moodle users with a nice authorisation screen with your Moodle site name and logo for your users to authorise.

Retrieved from "https://docs.moodle.org/34/en/index.php?title=Google_OAuth_2.0_setup&oldid=122959"
Powered by MediaWiki