Skip to content

Commit d804285

Browse files
committed
Clarify the release notes around SAML2 for v1.27.0.
1 parent 6600f0b commit d804285

File tree

2 files changed

+13
-12
lines changed

2 files changed

+13
-12
lines changed

CHANGES.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ Synapse 1.27.0 (2021-02-16)
33

44
Note that this release includes a change in Synapse to use Redis as a cache ─ as well as a pub/sub mechanism ─ if Redis support is enabled for workers. No action is needed by server administrators, and we do not expect resource usage of the Redis instance to change dramatically.
55

6-
This release also changes the callback URI for OpenID Connect (OIDC) identity providers. If your server is configured to use single sign-on via an OIDC/OAuth2 IdP, you may need to make configuration changes. Please review [UPGRADE.rst](UPGRADE.rst) for more details on these changes.
6+
This release also changes the callback URI for OpenID Connect (OIDC) and SAML2 identity providers. If your server is configured to use single sign-on via an OIDC/OAuth2 or SAML2 IdP, you may need to make configuration changes. Please review [UPGRADE.rst](UPGRADE.rst) for more details on these changes.
77

88
This release also changes escaping of variables in the HTML templates for SSO or email notifications. If you have customised these templates, please review [UPGRADE.rst](UPGRADE.rst) for more details on these changes.
99

UPGRADE.rst

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -88,20 +88,21 @@ for example:
8888
Upgrading to v1.27.0
8989
====================
9090

91-
Changes to callback URI for OAuth2 / OpenID Connect
92-
---------------------------------------------------
91+
Changes to callback URI for OAuth2 / OpenID Connect and SAML2
92+
-------------------------------------------------------------
9393

94-
This version changes the URI used for callbacks from OAuth2 identity providers. If
95-
your server is configured for single sign-on via an OpenID Connect or OAuth2 identity
96-
provider, you will need to add ``[synapse public baseurl]/_synapse/client/oidc/callback``
97-
to the list of permitted "redirect URIs" at the identity provider.
94+
This version changes the URI used for callbacks from OAuth2 and SAML2 identity providers:
9895

99-
See `docs/openid.md <docs/openid.md>`_ for more information on setting up OpenID
100-
Connect.
96+
* If your server is configured for single sign-on via an OpenID Connect or OAuth2 identity
97+
provider, you will need to add ``[synapse public baseurl]/_synapse/client/oidc/callback``
98+
to the list of permitted "redirect URIs" at the identity provider.
10199

102-
(Note: a similar change is being made for SAML2; in this case the old URI
103-
``[synapse public baseurl]/_matrix/saml2`` is being deprecated, but will continue to
104-
work, so no immediate changes are required for existing installations.)
100+
See `docs/openid.md <docs/openid.md>`_ for more information on setting up OpenID
101+
Connect.
102+
103+
* If your server is configured for single sign-on via a SAML2 identity provider, you will
104+
need to add ``[synapse public baseurl]/_synapse/client/saml2/authn_response`` as a permitted
105+
"ACS location" (also known as "allowed callback URLs") at the identity provider.
105106

106107
Changes to HTML templates
107108
-------------------------

0 commit comments

Comments
 (0)