From 4914a8882939337cc04d7e3e3162a9401489a437 Mon Sep 17 00:00:00 2001
From: Brendan Abolivier <babolivier@matrix.org>
Date: Mon, 10 Jun 2019 11:34:45 +0100
Subject: [PATCH] Doc

---
 synapse/api/auth.py | 5 +++++
 1 file changed, 5 insertions(+)

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: