Note: You are currently viewing documentation for Moodle 3.9. Up-to-date documentation for the latest stable version of Moodle may be available here: OAuth 2 Microsoft service.

OAuth 2 Microsoft service: Difference between revisions

From MoodleDocs
Main page ► Managing a Moodle site ► Server settings ► OAuth 2 services ► OAuth 2 Microsoft service
OAuth 2 services
No edit summary
 
(2 intermediate revisions by 2 users not shown)
Line 2: Line 2:
=== Setup App In Microsoft ===
=== Setup App In Microsoft ===


To setup  an OAuth 2 client with Microsoft, first we need to login to the [https://apps.dev.microsoft.com/#/appList Microsoft Application Console] and create a new app.
To set up an OAuth 2.0 client with Microsoft, you must first register a new application by using App registrations in the [https://portal.azure.com Azure Portal].  


[[Image:microsoft-1-create-new.png|none|frame|Create new project]]
1. From Azure Portal home, under 'Azure services', select 'Azure Active Directory'


Note: If you have previously registered Applications with an older API your Application Console may look different. In this case you should create a new "Converged Application".
2. From the left hand menu, select 'App registrations'


[[File:microsoft-1-1-alternate-app-page.png|none|frame|Create new project with older APIs enabled]]
3. Select 'New registration'


Choose a good name as this is what is shown to users when they are asked to approve the permissions.  
[[Image:ms_oauth2_2a.png|none|frame|Register new application]]


[[File:microsoft-2-name-it.png|none|frame|Name it]]
4. Choose a good name as this is what is shown to users when they are asked to approve the permissions.  


Next you have to add a platform to your application.  
5. For supported account types select 'Accounts in any organizational directory (Any Azure AD directory - Multitenant)'.


[[File:microsoft-3-add-platform.png|none|frame|Add platform]]
6. Choose 'Web' for redirect URI and add the callback URL. The callback URL should point to "your Moodle site URL + /admin/oauth2callback.php". If your Moodle site was available at <nowiki>https://lemon.edu/</nowiki> the callback URL would be <nowiki>https://lemon.edu/admin/oauth2callback.php</nowiki>. It is important that your Moodle site uses https and not http. Microsoft will not allow the callback url if it is not using https.


Choose "Web platform"
7. Click 'Register'.


[[File:microsoft-3.1-web-platform.png|none|frame|Web platform]]
[[File:ms_oauth2_5.png|none|frame|Application settings]]


Uncheck the "Allow Implicit Flow" checkbox and set the callback URL. The callback URL should point to "your Moodle site URL + /admin/oauth2callback.php". If your Moodle site was available at <nowiki>https://lemon.edu/</nowiki> the callback URL would be <nowiki>https://lemon.edu/admin/oauth2callback.php</nowiki>. It is important that your Moodle site uses https and not http. Microsoft will not allow the callback url if it is not using https.
8. Copy the 'Application (client) ID' to a safe place for later use.


[[File:microsoft-4-platform-settings.png|none|frame|Platform settings]]
[[File:ms_oauth2_6b.png|none|frame|Application (client) ID]]


Make sure the "Microsoft Graph Permissions" section contains the "User.Read" permission.
9. Select 'Authentication' from side-bar menu.


[[File:microsoft-5-permissions.png|none|frame|Permissions]]
[[File:ms_oauth2_12.png|none|frame|Authentication]]


Set the options for the consent screen.
10. Ensure implicit grant flow is disabled.


[[File:microsoft-6-consent.png|none|frame|Consent]]
[[File:ms_oauth2_13.png|none|frame|Disable Implict Grant Flow]]


Save all the details and then generate a new password.
11. Select 'API permissions' from side-bar menu.
[[File:ms_oauth2_6.png|none|frame|API permissions]]


[[File:microsoft-7-new-password.png|none|frame|Generate a new password]]
12. Make sure the "Microsoft Graph (1)" permissions section contains the "User.Read" permission.


Enter the password in Moodle as the "Client secret" and the Application ID as the "Client id".
[[File:ms_oauth2_7.png|none|frame|Microsoft Graph]]


[[File:microsoft-8-got-it.png|none|frame|Got it]]
13. Select 'Certificates & secrets' from side-bar menu.
 
[[File:ms_oauth2_8.png|none|frame|Certificates & secrets]]
 
14. Click 'New client secret' to create password/client secret.
 
[[File:ms_oauth2_9.png|none|frame|New client secret]]
 
15. Add a description and select when the password/secret will expire.
 
[[File:ms_oauth2_10.png|none|frame|Add a client secret]]
 
16. Copy the secret string value to a safe place for later use.
 
[[File:ms_oauth2_11.png|none|frame|Secret string value]]
 
17. In Moodle go to OAuth2 services (Site administration > Server > OAuth2 services) and create a new Microsoft service.
 
[[File:ms_oauth2_16.png|none|frame|Create new Microsoft service]]
 
18. Update the name if desired and enter the password/secret as the "Client secret" and the Application ID as the "Client ID".
 
[[File:ms_oauth2_14.png|none|frame|Add client ID and secret]]
 
19. Make any additional configuration changes such as limiting login domains, whether a login button will show on the login page, and if email verification is required.
 
[[File:ms_oauth2_15.png|none|frame|Addtional settings]]


==See also==
==See also==

Latest revision as of 06:15, 15 October 2020

Setup App In Microsoft

To set up an OAuth 2.0 client with Microsoft, you must first register a new application by using App registrations in the Azure Portal.

1. From Azure Portal home, under 'Azure services', select 'Azure Active Directory'

2. From the left hand menu, select 'App registrations'

3. Select 'New registration'

Register new application

4. Choose a good name as this is what is shown to users when they are asked to approve the permissions.

5. For supported account types select 'Accounts in any organizational directory (Any Azure AD directory - Multitenant)'.

6. Choose 'Web' for redirect URI and add the callback URL. The callback URL should point to "your Moodle site URL + /admin/oauth2callback.php". If your Moodle site was available at https://lemon.edu/ the callback URL would be https://lemon.edu/admin/oauth2callback.php. It is important that your Moodle site uses https and not http. Microsoft will not allow the callback url if it is not using https.

7. Click 'Register'.

Application settings

8. Copy the 'Application (client) ID' to a safe place for later use.

Application (client) ID

9. Select 'Authentication' from side-bar menu.

Authentication

10. Ensure implicit grant flow is disabled.

Disable Implict Grant Flow

11. Select 'API permissions' from side-bar menu.

API permissions

12. Make sure the "Microsoft Graph (1)" permissions section contains the "User.Read" permission.

Microsoft Graph

13. Select 'Certificates & secrets' from side-bar menu.

Certificates & secrets

14. Click 'New client secret' to create password/client secret.

New client secret

15. Add a description and select when the password/secret will expire.

Add a client secret

16. Copy the secret string value to a safe place for later use.

Secret string value

17. In Moodle go to OAuth2 services (Site administration > Server > OAuth2 services) and create a new Microsoft service.

Create new Microsoft service

18. Update the name if desired and enter the password/secret as the "Client secret" and the Application ID as the "Client ID".

Add client ID and secret

19. Make any additional configuration changes such as limiting login domains, whether a login button will show on the login page, and if email verification is required.

Addtional settings

See also

Retrieved from "https://docs.moodle.org/39/en/index.php?title=OAuth_2_Microsoft_service&oldid=138669"
Powered by MediaWiki