Google OAuth 2.0 setup: Difference between revisions
From MoodleDocs
(Converting to thumnails. This view still sucks though. I'm not a mediawiki guru.) |
Helen Foster (talk | contribs) (image positioning, template, categories) |
||
| 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/2012/04/changes-to-deprecation-policies-and-api.html Google announced] to web application developers that they would be deprecating 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'. The OAuth 2.0 system | {{Repositories}} | ||
==OAuth 2.0== | |||
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/2012/04/changes-to-deprecation-policies-and-api.html Google announced] to web application developers that they would be deprecating 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'. The OAuth 2.0 system provides a better security system and more friendly experience to Moodle users, though it requires some additional configuration in Moodle. | |||
==Registering with Google== | ==Registering with Google== | ||
| Line 5: | Line 8: | ||
# You will need to be signed into a google account | # You will need to be signed into a google account | ||
# Visit the | # 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. | # You will be asked to create a project if this is your first time using this form. | ||
# You need to click the button marked 'Create an OAuth 2.0 client ID..' | # You need to click the button marked 'Create an OAuth 2.0 client ID..' | ||
# 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. | # 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. | ||
# Next you will be asked for 'Client ID Settings' | # Next you will be asked for 'Client ID Settings' | ||
## For Application type, select 'Web application' | ## For Application type, select 'Web application' | ||
## Next to 'Your site or hostname' click '(more options)' | ## Next to 'Your site or hostname' click '(more options)' | ||
## In 'Authorized Redirect URIs' enter the URL which was provided in your Moodle settings page. (usually http://yourmoodle/admin/oauth2callback.php) | ## In 'Authorized Redirect URIs' enter the URL which was provided in your Moodle settings page. (usually http://yourmoodle/admin/oauth2callback.php) | ||
## In 'Authorized JavaScript Origins' leave the field blank | ## In 'Authorized JavaScript Origins' leave the field blank | ||
# Click 'Create client ID' | # Click 'Create client ID' | ||
# Your site is now registered with Google and you will be presented with your details. | # Your site is now registered with Google and you will be presented with your details. | ||
# Enter the 'Client ID' and 'Client secret' provided into your Moodle settings page | # Enter the 'Client ID' and 'Client secret' provided into your Moodle settings page | ||
== | |||
<gallery perrow=3 caption="Registering with Google - click on any to enlarge"> | |||
Image:google_oauth1.png|3. Creating API Project | |||
File:google_oauth2.png|4. Creating an OAuth 2.0 Client ID | |||
File:google_oauth2.png|4. Creating an OAuth 2.0 Client ID | |||
File:google_oauth3.png|5. Client Settings | |||
File:google_oauth4.png|9. Callback options | |||
File:google_oauth5.png|12. Registered details | |||
</gallery > | |||
Once configured, Google will present Moodle users with a nice authorisation screen with your moodle name and logo for your users to authorise: | Once configured, Google will present Moodle users with a nice authorisation screen with your moodle name and logo for your users to authorise: | ||
[[File:google_oauth6.png]] | |||
[[File:google_oauth6.png|thumb|left|Authorisation screen]] | |||
[[Category:Portfolios]] | |||
[[Category:Site administration]] | |||
Revision as of 15:20, 12 June 2012
OAuth 2.0
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, Google announced to web application developers that they would be deprecating 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'. The OAuth 2.0 system provides a better security system and more friendly experience to Moodle users, though it requires some additional configuration in Moodle.
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
- 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.
- You need to click the button marked 'Create an OAuth 2.0 client ID..'
- 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.
- Next you will be asked for 'Client ID Settings'
- For Application type, select 'Web application'
- Next to 'Your site or hostname' click '(more options)'
- In 'Authorized Redirect URIs' enter the URL which was provided in your Moodle settings page. (usually http://yourmoodle/admin/oauth2callback.php)
- In 'Authorized JavaScript Origins' leave the field blank
- Click 'Create client ID'
- Your site is now registered with Google and you will be presented with your details.
- Enter the 'Client ID' and 'Client secret' provided into your Moodle settings page
- Registering with Google - click on any to enlarge
3. Creating API Project
4. Creating an OAuth 2.0 Client ID
4. Creating an OAuth 2.0 Client ID
5. Client Settings
9. Callback options
12. Registered details
Once configured, Google will present Moodle users with a nice authorisation screen with your moodle name and logo for your users to authorise:
