minor #16405 [Security] Update impersonating_user.rst (ttskch)

javiereguiluz · javiereguiluz · commit a18880ad09e8 · 2022-03-21T16:35:47.000+01:00
This PR was merged into the 4.4 branch. Discussion ---------- [Security] Update impersonating_user.rst To use switching user feature via `HTTP_X_SWITCH_USER` header we have to set `switch_user.parameter: HTTP_X_SWITCH_USER` in security.yaml. refs: symfony/symfony#39907  Commits ------- 38b42b8 Update impersonating_user.rst
diff --git a/security/impersonating_user.rst b/security/impersonating_user.rst
@@ -75,7 +75,52 @@ as the value to the current URL:
 .. tip::
 
     Instead of adding a ``_switch_user`` query string parameter, you can pass
-    the username in a ``HTTP_X_SWITCH_USER`` header.
+    the username in a ``HTTP_X_SWITCH_USER`` header. You can use this feature by adjusting the ``parameter`` setting:
+
+    .. configuration-block::
+
+        .. code-block:: yaml
+
+            # config/packages/security.yaml
+            security:
+                # ...
+                firewalls:
+                    main:
+                        # ...
+                        switch_user: { parameter: HTTP_X_SWITCH_USER }
+
+        .. code-block:: xml
+
+            <!-- config/packages/security.xml -->
+            <?xml version="1.0" encoding="UTF-8" ?>
+            <srv:container xmlns="http://symfony.com/schema/dic/security"
+                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+                xmlns:srv="http://symfony.com/schema/dic/services"
+                xsi:schemaLocation="http://symfony.com/schema/dic/services
+                    https://symfony.com/schema/dic/services/services-1.0.xsd
+                    http://symfony.com/schema/dic/security
+                    https://symfony.com/schema/dic/security/security-1.0.xsd">
+                <config>
+                    <!-- ... -->
+                    <firewall name="main">
+                        <!-- ... -->
+                        <switch-user parameter="HTTP_X_SWITCH_USER"/>
+                    </firewall>
+                </config>
+            </srv:container>
+
+        .. code-block:: php
+
+            // config/packages/security.php
+            use Symfony\Config\SecurityConfig;
+            return static function (SecurityConfig $security) {
+                // ...
+                $security->firewall('main')
+                    // ...
+                    ->switchUser()
+                        ->parameter('HTTP_X_SWITCH_USER')
+                ;
+            };
 
 To switch back to the original user, use the special ``_exit`` username:
 
