summary refs log tree commit diff
path: root/synapse/handlers
diff options
context:
space:
mode:
authorPeter Scheu <32014443+peterscheu-aceart@users.noreply.github.com>2022-09-21 15:08:16 +0200
committerGitHub <noreply@github.com>2022-09-21 13:08:16 +0000
commit16e1a9d9a7884967da390ef967b942a5e35e8f6c (patch)
treef319efa71b467513c5f8334e93f29a7e0806176e /synapse/handlers
parentImprove the `synapse.api.auth.Auth` mock used in unit tests. (#13809) (diff)
downloadsynapse-16e1a9d9a7884967da390ef967b942a5e35e8f6c.tar.xz
Correct documentation for map_user_attributes of OpenID Mapping Providers (#13836)
Co-authored-by: David Robertson <davidr@element.io>
Diffstat (limited to 'synapse/handlers')
-rw-r--r--synapse/handlers/sso.py3
1 files changed, 3 insertions, 0 deletions
diff --git a/synapse/handlers/sso.py b/synapse/handlers/sso.py
index 1e171f3f71..6bc1cbd787 100644
--- a/synapse/handlers/sso.py
+++ b/synapse/handlers/sso.py
@@ -128,6 +128,9 @@ class SsoIdentityProvider(Protocol):
 
 @attr.s(auto_attribs=True)
 class UserAttributes:
+    # NB: This struct is documented in docs/sso_mapping_providers.md so that users can
+    # populate it with data from their own mapping providers.
+
     # the localpart of the mxid that the mapper has assigned to the user.
     # if `None`, the mapper has not picked a userid, and the user should be prompted to
     # enter one.