User key authentication

Authentication ::: auth_userkey
Maintained by Catalyst IT, Dmitrii Metelkin, Brendan Heywood, Marcus Boon, Adam Riddell
Log in to Moodle using one time user key based login URL. Auth plugin for organising simple SSO (single sign on) between moodle and your external web application.
Latest release:
1485 sites
537 downloads
51 fans
Current versions available: 2

Log in to Moodle using one time user key.

Auth plugin for organising simple one way SSO(single sign on) between moodle and your external web application. The main idea is to make a web call to moodle and provide one of the possible matching fields to find required user and generate one time login URL. A user can be redirected to this URL to be log in to Moodle without typing username and password.

The plugin supports user provisioning.


Using

Read plugin documentation.

Screenshots

Screenshot #0

Contributors

Catalyst IT (Lead maintainer)
Dmitrii Metelkin
Please login to view contributors details and/or to contact them

Comments RSS

Comments

  • David Mudrák
    Fri, 26 Aug 2016, 6:45 PM

    Thanks Dmitrii for sharing this plugin with the community. I was able to successfully test the functionality (with a small usability issue detected - redirecting after the sign in - which I reported to your tracker). The design and implementation if clean and easy to follow and understand. I like the interface userkey_manager_interface allowing for alternative implementation of the actual keys generation and storage in the future.

    You are cleared to land now, welcome to the Plugins directory!

  • Vikram Sra
    Thu, 5 Jan 2017, 2:25 PM
    Any sample code to test the plugin ?
  • Dmitrii Metelkin
    Wed, 29 Mar 2017, 9:19 AM
    Hi Vikram Sra,

    You can use this code https://github.com/moodlehq/sample-ws-clients to build your test client. Also don't forget to configure your moodle to work with web services and configure auth_userkey plugin using this doc https://github.com/catalyst/moodle-auth_userkey/blob/master/README.md

    Please let me know if you have any questions.

  • Marwan Salem
    Fri, 7 July 2017, 12:56 AM
    HI! I am looking for login integration between Moodle and my web application done with PHP. Where can I find any solutions? thanks for your help!
  • Dmitrii Metelkin
    Fri, 7 July 2017, 8:01 AM
    Hi Marwan Salem,

    It usually depends on what sort of integration are you after. This plugin is ideally for organising SSO with your application and moodle.

    Very simple scenario:
    1. Install and configure auth_userkey plugin for your moodle.
    2. Create a script in your web application to interact with moodle auth_userkey plugin to generate login key for users and redirect them to moodle.
    3. Put some link in your web application to let users to click on it and execute the script from step 2.
    4. Profit.

    Look at documentation to find some PHP code examples for testing https://github.com/catalyst/moodle-auth_userkey/blob/master/README.md

  • Brendan Heywood
    Fri, 7 July 2017, 8:31 AM
    hi Marwan,

    Your requirements are very open ended, and there are many out of the box solutions, ie SAML, CAS, Auth2 etc which could make the integration easier. This plugin may or may not be the best solution.

    If you would like commercial help please contact us:

    https://www.catalyst-au.net/contact-us
  • Simon Brenner
    Mon, 10 July 2017, 8:56 PM
    Hi,

    the plugin page says that this plugin is compatible with Moodle 3.3 - but as the comment on GIT hub

    https://github.com/catalyst/moodle-auth_userkey/issues/15#issuecomment-306955454

    points out, its currently not working with 3.3. The version info on this page should be corrected to save users some hassle.
  • Brendan Heywood
    Tue, 11 July 2017, 7:29 AM
    thanks Simon I have just fixed that metadata.
  • Sai Prasad
    Thu, 31 Aug 2017, 2:24 AM
    im getting error when trying to install this: below is the detail:

    Stack trace: •line 513 of \cache\classes\definition.php: coding_exception thrown
    •line 515 of \cache\classes\helper.php: call to cache_definition::load()
    •line 480 of \cache\classes\helper.php: call to cache_helper::purge_store()
    •line 1737 of \lib\upgradelib.php: call to cache_helper::purge_all()
    •line 683 of \admin\index.php: call to upgrade_noncore()


    can any one help??
  • Sai Prasad
    Thu, 31 Aug 2017, 2:25 AM
    it says coding error
  • Dmitrii Metelkin
    Thu, 31 Aug 2017, 8:08 AM
    Hi Sai Prasad,

    It's really hard to say what is broken based on your description as trace you attached is related to some errors in cache class. If you do believe that this error is triggered by auth_userkey plugin please feel free to create an issue in https://github.com/catalyst/moodle-auth_userkey Please provide more details for us to replicate it (Moodle version, any specific settings and etc)

    Also, have you tried to install other plugins? Maybe it's a just general error you are getting for any plugin?

    Thanks,
    Dmitrii
  • Sai Prasad
    Fri, 1 Sept 2017, 12:42 AM
    I went through and deleted config file under muc folder , it worked thanks for your help.
  • Sai Prasad
    Fri, 1 Sept 2017, 12:58 AM
    installed plugin successfully ,using this user cannot directly login using moodle login page right?

    could you give me an example of how to call from external application ?, as I'm using asp.net application
  • Dmitrii Metelkin
    Fri, 1 Sept 2017, 9:47 AM
    Hi Sai Prasad,

    That's correct, users who have this auth method set can't login directly to moodle.
    Unfortunately I'm not able to provide any .NET examples. You can find a PHP example in the plugin docs https://github.com/catalyst/moodle-auth_userkey/blob/master/README.md

    Cheers,
    Dmitrii
Please login to post comments