Skip to content
This repository was archived by the owner on Apr 26, 2024. It is now read-only.

Commit c868274

Browse files
Update synapse/handlers/auth.py
Co-authored-by: Patrick Cloke <clokep@users.noreply.github.com>
1 parent de9fe23 commit c868274

File tree

1 file changed

+7
-4
lines changed

1 file changed

+7
-4
lines changed

synapse/handlers/auth.py

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -56,11 +56,14 @@
5656
def client_dict_convert_legacy_fields_to_identifier(
5757
submission: Dict[str, Union[str, Dict]]
5858
):
59-
"""Take a legacy-formatted login submission or User-Interactive Authentication dict and
60-
updates it to feature an identifier dict instead.
61-
Providing user-identifying information at the top-level of a login or UIA submission is
62-
now deprecated and replaced with identifiers:
59+
"""
60+
Convert a legacy-formatted login submission to an identifier dict.
61+
62+
Legacy login submissions (used in both login and user-interactive authentication)
63+
provide user-identifying information at the top-level instead of in an `indentifier`
64+
property. This is now deprecated and replaced with identifiers:
6365
https://matrix.org/docs/spec/client_server/r0.6.1#identifier-types
66+
6467
Args:
6568
submission: The client dict to convert. Passed by reference and modified
6669
Raises:

0 commit comments

Comments
 (0)