Documented the logout_on_user_change option

symfony · javiereguiluz · May 28, 2018 · May 29, 2018 · May 28, 2018 · 9626c64444f31a48af6c30e58d0865416f31e4f8
commit 9626c64444f31a48af6c30e58d0865416f31e4f8
diff --git a/reference/configuration/security.rst b/reference/configuration/security.rst
@@ -141,6 +141,7 @@ Each part will be explained in the next section.
                    # See "Firewall Context" below for more details
                    context: context_key
                    stateless: false
+                    logout_on_user_change: false
                    x509:
                        provider: some_key_from_above
                    remote_user:
@@ -450,6 +451,18 @@ The ``invalidate_session`` option allows to redefine this behavior. Set this
 option to ``false`` in every firewall and the user will only be logged out from
 the current firewall and not the other ones.

+logout_on_user_change
+~~~~~~~~~~~~~~~~~~~~~
+
+**type**: ``boolean`` **default**: ``false``
+
+.. versionadded:: 3.4
+    The ``logout_on_user_change`` option was introduced in Symfony 3.4.
+
+If ``true`` this option makes Symfony to trigger a logout when the user has
+changed. Not doing that is deprecated, so this option should be set to ``true``
+to avoid getting deprecation messages.
+
 .. _reference-security-ldap:

 LDAP functionality