summary refs log tree commit diff
diff options
context:
space:
mode:
authorAndrew Morgan <andrew@amorgan.xyz>2020-06-16 11:39:19 +0100
committerAndrew Morgan <andrew@amorgan.xyz>2020-06-16 11:39:19 +0100
commitb1c0eb317880cf8ab67a5ba041f1eb3a266dd436 (patch)
treefc8a97407d3053197f0889742c0fc62898372e58
parentChange SynapseError comment (diff)
downloadsynapse-b1c0eb317880cf8ab67a5ba041f1eb3a266dd436.tar.xz
Docstring spacing
-rw-r--r--synapse/handlers/auth.py4
1 files changed, 4 insertions, 0 deletions
diff --git a/synapse/handlers/auth.py b/synapse/handlers/auth.py

index 39f92a06fb..f687a68031 100644 --- a/synapse/handlers/auth.py +++ b/synapse/handlers/auth.py
@@ -634,15 +634,19 @@ class AuthHandler(BaseHandler): """Given a dictionary containing an identifier from a client, extract the possibly unqualified username of the user that it identifies. Does *not* guarantee that the user exists. + If this identifier dict contains a threepid, we attempt to ask password auth providers about it or, failing that, look up an associated user in the database. + Args: identifier: The identifier dictionary provided by the client password: The user provided password if one exists. Used for asking password auth providers for usernames from 3pid+password combos. + Returns: A username if one was found, or None otherwise + Raises: SynapseError: If the identifier dict is invalid """