OAuth 2 LinkedIn service: Difference between revisions

From MoodleDocs
Main page ► Managing a Moodle site ► Server settings ► OAuth 2 services ► OAuth 2 LinkedIn service
OAuth 2 services
m (Added link to spanish translation of page)
(updating with ref to MDL-79181)
 
(8 intermediate revisions by 6 users not shown)
Line 1: Line 1:
{{OAuth2}}
{{OAuth2}}
=== Setup App in LinkedIn ===


To setup an OAuth 2 client with LinkedIn, first we need to login to the [https://developer.linkedin.com/ LinkedIn Developers page] and create a new app.
== 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.


[[File:linkedin-1-new-app.png|none|frame|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.


Enable the r_basicprofile and r_emailaddress permissions and enter the OAuth 2 authorized redirect URL. This is your site url followed by /admin/oauth2callback.php (e.g. for a Moodle site of <nowiki>https://teach.me/moodle/</nowiki> the callback url should be <nowiki>https://teach.me/moodle/admin/oauth2callback.php</nowiki>).
[[File:ouath2linkedin.png]]


[[File:linkedin-2-configure-app.png|none|frame|Configure App]]


Make sure you save your changes and record your client id and client secret.
Users will now see a LinkedIn option when logging in to your site.
 
[[File:LinkedInlogin.png|left|500px]]
Now you have configured your LinkedIn App - you can add the required information to Moodle.
 
LinkedIn does not have a "template" in Moodle so we will need to configure it as a "Custom OAuth 2 Service". From the "Site administration > Server > OAuth 2 services" page click on "Create new custom service".
 
Use "LinkedIn" as the name (This is displayed on the login page).
 
Enter your client id and secret for the LinkedIn App that you created earlier.
 
For the "Scopes included in a login request" and "Scopes included in a login request for offline access" use "r_basicprofile r_emailaddress" which means fetch basic profile information as well as the users email address.
 
Enter a url to a logo image.
 
Check the box for "Show on login page".
 
Save the details and you should be returned to the list of OAuth 2 Services.
 
We still need to provide information on the mappings between linked in user fields and moodle fields as well as the URL's to access the LinkedIn APIs.
 
First we will setup the API URL's.
 
Click on the "Configure Endpoints" icon for the LinkedIn service.
 
Add 3 endpoints as listed below.
 
<code>
userinfo_endpoint https://api.linkedin.com/v1/people/~:(id,email-address,first-name,last-name,picture-url)?format=json
 
authorization_endpoint https://www.linkedin.com/oauth/v2/authorization
 
token_endpoint https://www.linkedin.com/oauth/v2/accessToken
</code>
 
Now we need to add the mapping from LinkedIn user fields to Moodle user fields. From the list of OAuth services click on the "Configure user field mappings" icon.
 
Add the following user field mappings:
 
<code>
firstName firstname
lastName lastname
emailAddress username
emailAddress email
pictureUrl picture
</code>
 
The final step is to make sure the OAuth 2 authentication plugin is enabled and you should now be able to login with LinkedIn.
 
[[es:Servicio OAuth 2 Linkedln]]

Latest 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
Retrieved from "https://docs.moodle.org/403/en/index.php?title=OAuth_2_LinkedIn_service&oldid=147492"
Powered by MediaWiki