Matrix-Mirrors/anonymousland-synapse
1
0
Fork 0
mirror of https://git.anonymousland.org/anonymousland/synapse.git synced 2025-09-29 00:19:28 -04:00
Code Issues Projects Releases Packages Wiki Activity

Notify auth providers on logout

Browse source 
Provide a hook by which auth providers can be notified of logouts.
This commit is contained in:
Richard van der Hoff 2017-11-01 15:42:38 +00:00
parent 846a94fbc9
commit bc8a5c0330
3 changed files with 42 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

10
docs/password_auth_providers.rst
View file

@ -82,3 +82,13 @@ Password auth provider classes may optionally provide the following methods.
The method should return a Twisted ``Deferred`` object, which resolves to
``True`` if authentication is successful, and ``False`` if not.
``someprovider.on_logged_out``\(*user_id*, *device_id*, *access_token*)
This method, if implemented, is called when a user logs out. It is passed
the qualified user ID, the ID of the deactivated device (if any: access
tokens are occasionally created without an associated device ID), and the
(now deactivated) access token.
It may return a Twisted ``Deferred`` object; the logout request will wait
for the deferred to complete but the result is ignored.