summary refs log tree commit diff
path: root/synapse/api/auth.py
diff options
context:
space:
mode:
authorBrendan Abolivier <babolivier@matrix.org>2019-06-10 11:34:45 +0100
committerBrendan Abolivier <babolivier@matrix.org>2019-06-10 11:34:45 +0100
commit4914a8882939337cc04d7e3e3162a9401489a437 (patch)
tree39e2b6629d9b830b24e6178b186269d1e55ff1ff /synapse/api/auth.py
parentGah towncrier (diff)
downloadsynapse-4914a8882939337cc04d7e3e3162a9401489a437.tar.xz
Doc
Diffstat (limited to 'synapse/api/auth.py')
-rw-r--r--synapse/api/auth.py5
1 files changed, 5 insertions, 0 deletions
diff --git a/synapse/api/auth.py b/synapse/api/auth.py
index e24d942553..a04be32890 100644
--- a/synapse/api/auth.py
+++ b/synapse/api/auth.py
@@ -195,6 +195,11 @@ class Auth(object):
 
         Args:
             request - An HTTP request with an access_token query parameter.
+            allow_expired - Whether to allow the request through even if the account is
+                expired. If true, Synapse will still require the access token to be
+                provided but won't check if the account it belongs to has expired. This
+                works thanks to /login delivering access tokens regardless of accounts'
+                expiration.
         Returns:
             defer.Deferred: resolves to a ``synapse.types.Requester`` object
         Raises: