Skip to content

Commit c370cb1

Browse files
authoredAug 16, 2023
Update README.md (#94)
* Update README.md userkey authentication plugin must be enabled before usage * Update README.md enable plugin configuration steps added * Update README.md removed unneeded step 9 * Update README.md numbering order changed
1 parent e60e6d4 commit c370cb1

File tree

1 file changed

+10
-8
lines changed

1 file changed

+10
-8
lines changed
 

‎README.md

+10-8
Original file line numberDiff line numberDiff line change
@@ -13,14 +13,16 @@ URL to be log in to Moodle without typing username and password.
1313
Using
1414
-----
1515
1. Install the plugin as usual.
16-
2. Enable and configure just installed plugin. Set required Mapping field, User key life time, IP restriction and Logout redirect URL.
17-
3. Enable web service advance feature (Admin > Advanced features), more info http://docs.moodle.org/en/Web_services
18-
4. Enable one of the supported protocols (Admin > Plugins > Web services > Manage protocols)
19-
5. Create a token for a specific user and for the service 'User key authentication web service' (Admin > Plugins > Web services > Manage tokens)
20-
6. Make sure that the "web service" user has 'auth/userkey:generatekey' capability.
21-
7. Authorise the "web service" user: Admin > Plugins > Web services > External services, select 'Authorised users' for the web service, and add the user.
22-
8. Configure your external application to make a web call to get login URL.
23-
9. Redirect your users to this URL to be logged in to Moodle.
16+
2. Enable the userkey authentication plugin (Site administration -> Plugins -> Authentication and then enable User key).
17+
3. Configure the plugin. Set required Mapping field, User key life time, IP restriction and Logout redirect URL.
18+
4. Enable and configure just installed plugin. Set required Mapping field, User key life time, IP restriction and Logout redirect URL.
19+
5. Enable web service advance feature (Admin > Advanced features), more info http://docs.moodle.org/en/Web_services
20+
6. Enable one of the supported protocols (Admin > Plugins > Web services > Manage protocols)
21+
7. Create a token for a specific user and for the service 'User key authentication web service' (Admin > Plugins > Web services > Manage tokens)
22+
8. Make sure that the "web service" user has 'auth/userkey:generatekey' capability.
23+
9. Authorise the "web service" user: Admin > Plugins > Web services > External services, select 'Authorised users' for the web service, and add the user.
24+
10. Configure your external application to make a web call to get login URL.
25+
11. Redirect your users to this URL to be logged in to Moodle.
2426

2527
Configuration
2628
-------------

0 commit comments

Comments
 (0)
Please sign in to comment.