OAuth 2 LinkedIn service: Difference between revisions

From MoodleDocs
(page requires updating template)
(updating with ref to MDL-79181)
Line 1: Line 1:
{{OAuth2}}
{{OAuth2}}
{{Update}}
 
== LinkedIn setup ==
== LinkedIn setup ==
To setup an OAuth 2 client with LinkedIn, first we need to login to the [https://www.linkedin.com/developers/ LinkedIn Developers page] and create a new app.
To setup an OAuth 2 client with LinkedIn, first we need to login to the [https://www.linkedin.com/developers/ LinkedIn Developers page] and create a new app.


On the 'Create an app' page, fill in the required fields:
*Request access and  add the product "Sign in with LinkedIn using OpenID Connect".
* App name
*Make sure you've set the "Authorized redirect URLs for your app" to: YOURSITE/admin/oauth2callback.php
* LinkedIn Page - The page that this app will be associated with
*Go to your Moodle site and log in as admin.
* App Logo
*Go to "Site admin > Plugins > Authentication" and enable the "OAuth2" authentication plugin
[[File:linkedin app creation.png]]
*Go to "Site admin > Server > OAuth 2 Services"
 
*Click the "LinkedIn" button
After you're done creating the app, you will be redirected to a screen where you can manage various settings related to the app.
*Enter your Client ID and Client secret (You'll find these on the 'Auth' tab of your LinkedIn dev portal app.)
 
*Decide whether or not to  uncheck "Require email verification" -and if you do uncheck it, tick the "I understand that disabling email verification can be a security issue" box to confirm.
=== Permissions / Scope requirements ===
*Save changes.
For the client to function properly, it needs to be granted permissions to retrieve information from a user. LinkedIn does this easily by defining 'Products' that an app can be associated with. Each product defines the various use case that the API can be used for. For Moodle purposes, we only require the 'Sign In with LinkedIn' product.
 
Go to the Products tab and select the 'Sign In with LinkedIn' product
 
[[File:linkedin products prior selection.png]]
 
The product will be marked as 'Review in progress' and will take a few minutes to be approved. Once done, the product will be listed in the app's 'Added products' section.
 
[[File:linkedin added products.png]]
 
=== Client settings ===
Once the product have been successfully added, go to the 'Auth' tab. Here you will find the Authentication keys required to setup your issuer in Moodle. You will have to setup the authorised redirect URLs as is standard for OAuth2.
 
[[File:linkedin auth page.png]]
 
You will also find the OAuth2 scopes listed which was done as part of Scope requirements earlier.  


[[File:linkedin scopes defined.png]]
[[File:ouath2linkedin.png]]


== Issuer configuration ==
Authentication via LinkedIn is now a preconfigured service available for administrators. Go to 'Site Admin -> Server -> OAuth2 services' and click on the LinkedIn button.
All you need now is to enter and save the client id and secret and LinkedIn will now be an option for a user on the login page.


== See also ==
Users will now see a LinkedIn option when logging in to your site.
* MDL-65637
[[File:LinkedInlogin.png|left|500px]]

Revision as of 15:26, 3 December 2023


LinkedIn setup

To setup an OAuth 2 client with LinkedIn, first we need to login to the LinkedIn Developers page and create a new app.

  • Request access and add the product "Sign in with LinkedIn using OpenID Connect".
  • Make sure you've set the "Authorized redirect URLs for your app" to: YOURSITE/admin/oauth2callback.php
  • Go to your Moodle site and log in as admin.
  • Go to "Site admin > Plugins > Authentication" and enable the "OAuth2" authentication plugin
  • Go to "Site admin > Server > OAuth 2 Services"
  • Click the "LinkedIn" button
  • Enter your Client ID and Client secret (You'll find these on the 'Auth' tab of your LinkedIn dev portal app.)
  • Decide whether or not to uncheck "Require email verification" -and if you do uncheck it, tick the "I understand that disabling email verification can be a security issue" box to confirm.
  • Save changes.

ouath2linkedin.png


Users will now see a LinkedIn option when logging in to your site.

LinkedInlogin.png