OAuth 2 authentication
Note: You are currently viewing documentation for Moodle 3.3. Up-to-date documentation for the latest stable version of Moodle is probably available here: OAuth 2 authentication.
in Moodle 3.3!
- 1 Log in using your account on another site
- 2 Enabling OAuth 2 authentication
- 3 Preventing new account creation
- 4 Troubleshooting
- 4.1 On the 'OAuth 2 services' page, there is a red cross for 'Allow login'
- 4.2 I obtain a coding error after enabling OAuth 2 authentication
- 4.3 I obtain an error message when attempting to log in using Facebook
- 4.4 I see a "required paramenter (code) was missing" error after logging into the OAuth 2 service
Log in using your account on another site
The OAuth 2 authentication plugin enables users to log in using their Google, Microsoft and/or Facebook account via buttons on the login page.
If account creation is enabled, when a user first logs in, a new account will be created. Otherwise, they will be prompted to link it to their existing account with the same email address.
Enabling OAuth 2 authentication
To use OAuth 2 authentication, an administrator must first create the required OAuth 2 services.
- Go to 'OAuth 2 services' in Site administration > Server and click the button to create a new service.
- Follow the instructions in OAuth 2 Google service, OAuth 2 Microsoft service or OAuth 2 Facebook service and obtain a client ID and secret.
- Enter the client ID and secret, make sure 'Show on login page' is ticked, then save changes.
Repeat for additional services as desired. For OAuth 2 authentication, there is no need to connect to a system account.
- Go to 'Manage authentication' in Site administration and enable the OAuth 2 authentication plugin.
- Optional: In the OAuth 2 settings, lock selected user data fields and save changes.
Preventing new account creation
If you don't want new accounts to be created when users log in with an OAuth 2 service:
- Go to 'Manage authentication' in Site administration and tick the box 'Prevent account creation when authenticating' (authpreventaccountcreation).
- Click the 'Save changes' button.
On the 'OAuth 2 services' page, there is a red cross for 'Allow login'
To get a green tick for Allow login, edit the OAuth 2 service and make sure that the setting 'Show on login page' is ticked.
I obtain a coding error after enabling OAuth 2 authentication
Have you any OAuth 2 plugins for earlier versions installed on your site? If so, you will need to uninstall them in order to use the standard OAuth 2 authentication.
I obtain an error message when attempting to log in using Facebook
The error message 'The user information returned did not contain a username and email address. The OAuth 2 service may be configured incorrectly.' is most likely because the user's Facebook account was created using a mobile number.
The solution is for the user to first log in to Facebook and add a username and email address there.
I see a "required paramenter (code) was missing" error after logging into the OAuth 2 service
The error message 'A required parameter (code) was missing' can be caused by a mis-configured webserver. OAuth 2 relies on long tokens passed as url parameters, and some webserver configurations will prevent this from working. See http://www.php.net/manual/en/reserved.variables.get.php#101469 for one possible solution.