Correct documentation for map_user_attributes of OpenID Mapping Providers (#13836)

Co-authored-by: David Robertson <davidr@element.io>
This commit is contained in:
Peter Scheu 2022-09-21 15:08:16 +02:00 committed by GitHub
parent e0804ef898
commit 16e1a9d9a7
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 13 additions and 3 deletions

View file

@ -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.