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
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.


Read plugin documentation.


Screenshot #0


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

Comments RSS

Show comments
  • Marini Marini
    Tue, Jul 9, 2019, 7:43 PM
    Hi good morning,
    It is posible pass the field city or a custom field?
  • Dmitrii Metelkin
    Wed, Jul 10, 2019, 5:39 AM
    Hi Marini,
    In the current implementation it's not possible to pass the field city or a custom field. But feel free to submit a feature request in github
  • Pär Brink
    Fri, Dec 13, 2019, 10:31 PM
    We are using auth_userkey on Moodle 3.5.2+. However, our users are promted to forced change of password.
    I saw some previous comments with the same issue, but no solution.
    Is this a known issue and is there a solution for it?

  • Dmitrii Metelkin
    Mon, Dec 16, 2019, 5:59 AM
    Hi Pär Brink
    Please make sure you use the latest version of the plugin. The best way to get this looked at is to raise an issue in github Make sure provide full steps to replicate it the issue.
  • Juan Duque
    Sat, May 23, 2020, 5:17 AM
    From this plugin can you update the extra fields?
  • Catalyst IT
    Mon, May 25, 2020, 7:47 AM
    Hi Juan!
    You can't do it currently, but there is a pull request currently in progress that potentially can bring this features. See
  • Juan Duque
    Fri, May 29, 2020, 5:31 AM

    Ok, I'll be waiting for when this update is released.

    Thanks for the reply.
  • Juan Duque
    Thu, Jun 18, 2020, 10:02 AM
    The log out system is only executed by entering the logout url of the userkey. Is there no way to logout how to login userkey?
  • Dmitrii Metelkin
    Thu, Jun 18, 2020, 10:11 AM
    Hi Juan! Not sure if I understand your question. There is a logout functionality described in README Basically you can use "Redirect after logout from Moodle" setting to logout users from your App when they logged out from Moodle. From the pother end, you can use logout URL functionality to logout users from Moodle when they log out from your APP. So you redirect them to url like Hope that makes sense.
  • Juan Duque
    Thu, Jun 18, 2020, 10:19 AM
    Yes, I understand that functionality. But it can only be used by entering the url exposed by the plugin and redirecting it to where the return parameter is.

    Is there a way that I can log out from a use of the service, without having to send the person to moodle in the browser?
  • Dmitrii Metelkin
    Thu, Jun 18, 2020, 10:25 AM
    hey Juan, Please raise an issue in github and try to explain your case in more details.
  • Станислав Тихонов
    Mon, Sep 21, 2020, 10:44 PM
    Hi. I have a question: user privacy key is expired. Trying to login return error - expiredkey. New key not generate. What i can do to fix that? Thx
  • Danijel Todic
    Thu, Jul 14, 2022, 5:40 AM
    Hi, is this Plugin compatible with Moodle 4.0 ? When is a version for Moodle 4.0 planned?
  • Neil Young
    Fri, May 26, 2023, 8:07 PM
    Hi Team

    I was wondering if you could tell me if there is planned upgrade of this plugin to 4.1 or 4.2? if so do you have an indicative date for the upgrade?
    Kind Regards
  • Giulio Stumpo
    Fri, Feb 16, 2024, 1:01 AM
    Hi Team,
    I was wondering if an upgrade to Moodle 4.3.3. is planned.
    Kind Regards
1 2 3
Please login to post comments