summary refs log tree commit diff
path: root/docs
diff options
context:
space:
mode:
authorChristopher Cooper <christopher.c.cooper@gmail.com>2020-05-27 09:40:08 -0700
committerGitHub <noreply@github.com>2020-05-27 17:40:08 +0100
commitc4a820b32a41dd5d8479144a2ad04d6446475013 (patch)
treebbe655aa9de9a0d6b5fbeda29d0f85f6c93a92b7 /docs
parentMerge tag 'v1.14.0rc2' into develop (diff)
downloadsynapse-c4a820b32a41dd5d8479144a2ad04d6446475013.tar.xz
allow emails to be passed through SAML (#7385)
Signed-off-by: Christopher Cooper <cooperc@ocf.berkeley.edu>
Diffstat (limited to 'docs')
-rw-r--r--docs/sso_mapping_providers.md2
1 files changed, 2 insertions, 0 deletions
diff --git a/docs/sso_mapping_providers.md b/docs/sso_mapping_providers.md
index 4cd3a568f2..abea432343 100644
--- a/docs/sso_mapping_providers.md
+++ b/docs/sso_mapping_providers.md
@@ -138,6 +138,8 @@ A custom mapping provider must specify the following methods:
        * `mxid_localpart` - Required. The mxid localpart of the new user.
        * `displayname` - The displayname of the new user. If not provided, will default to
                          the value of `mxid_localpart`.
+       * `emails` - A list of emails for the new user. If not provided, will
+                    default to an empty list.
 
 ### Default SAML Mapping Provider