diff options
Diffstat (limited to 'docs/password_auth_providers.rst')
| -rw-r--r-- | docs/password_auth_providers.rst | 10 |
1 files changed, 10 insertions, 0 deletions
diff --git a/docs/password_auth_providers.rst b/docs/password_auth_providers.rst index 4ae4aeb53f..2842d187e5 100644 --- a/docs/password_auth_providers.rst +++ b/docs/password_auth_providers.rst @@ -87,3 +87,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. |