Difference between revisions of "OAuth 2 authentication"

Jump to: navigation, search
m (Added link to spanish translation of page)
(description, enabling OAuth 2 auth, preventing new account creation, category)
Line 1: Line 1:
 
{{Authentication}}{{New features}}
 
{{Authentication}}{{New features}}
 +
The OAuth 2 authentication plugin enables users to log in using their Google, Microsoft and/or Facebook account. If enabled, when a user first logs in, a new account will be created. Otherwise, they will be prompted to [[Linked logins|link it to their existing account]] with the same email address.
 +
[[File:oauth 2 auth.png|thumb|Login page with options to log in with an OAuth 2 service]]
  
 +
==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 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 and save changes.
 +
# Repeat for additional services as desired.
 +
# 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.
 +
 +
[[Category:OAuth 2]]
  
 
[[es:Autenticación OAuth 2]]
 
[[es:Autenticación OAuth 2]]

Revision as of 10:12, 14 May 2017

New feature
in Moodle 3.8!

The OAuth 2 authentication plugin enables users to log in using their Google, Microsoft and/or Facebook account. If 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.

Login page with options to log in with an OAuth 2 service

Enabling OAuth 2 authentication

To use OAuth 2 authentication, an administrator must first create the required OAuth 2 services.

  1. Go to 'OAuth 2 services' in Site administration and click the button to create a new service.
  2. Follow the instructions in OAuth 2 Google service, OAuth 2 Microsoft service or OAuth 2 Facebook service and obtain a client ID and secret.
  3. Enter the client ID and secret and save changes.
  4. Repeat for additional services as desired.
  5. Go to 'Manage authentication' in Site administration and enable the OAuth 2 authentication plugin.
  6. 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:

  1. Go to 'Manage authentication' in Site administration and tick the box 'Prevent account creation when authenticating' (authpreventaccountcreation).
  2. Click the 'Save changes' button.