8000 Improve security logout options · symfony/symfony-docs@e95b95a · GitHub
[go: up one dir, main page]

Skip to content

Commit e95b95a

Browse files
committed
Improve security logout options
1 parent a737539 commit e95b95a

File tree

1 file changed

+11
-8
lines changed

1 file changed

+11
-8
lines changed

reference/configuration/security.rst

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -448,10 +448,13 @@ redirected to the ``default_target_path`` to avoid a redirection loop.
448448
For historical reasons, and to match the misspelling of the HTTP standard,
449449
the option is called ``use_referer`` instead of ``use_referrer``.
450450

451-
**Options Related to Logout Configuration**
451+
logout
452+
~~~~~~
453+
454+
You can configure logout options.
452455

453456
invalidate_session
454-
~~~~~~~~~~~~~~~~~~
457+
..................
455458

456459
**type**: ``boolean`` **default**: ``true``
457460

@@ -466,14 +469,14 @@ the current firewall and not the other ones.
466469
.. _reference-security-logout-success-handler:
467470

468471
``path``
469-
~~~~~~~~
472+
........
470473

471474
**type**: ``string`` **default**: ``/logout``
472475

473476
The path which triggers logout. You need to set up a route with a matching path.
474477

475478
target
476-
~~~~~~
479+
......
477480

478481
**type**: ``string`` **default**: ``/``
479482

@@ -482,7 +485,7 @@ starts with ``http://`` or ``https://``) or the route name (otherwise) to
482485
redirect after logout.
483486

484487
success_handler
485-
~~~~~~~~~~~~~~~
488+
...............
486489

487490
.. deprecated:: 5.1
488491

@@ -501,22 +504,22 @@ If it is set, the logout ``target`` option will be ignored.
501504
.. _reference-security-logout-csrf:
502505

503506
csrf_parameter
504-
~~~~~~~~~~~~~~
507+
..............
505508

506509
**type**: ``string`` **default**: ``'_csrf_token'``
507510

508511
The name of the parameter that stores the CSRF token value.
509512

510513
csrf_token_generator
511-
~~~~~~~~~~~~~~~~~~~~
514+
....................
512515

513516
**type**: ``string`` **default**: ``null``
514517

515518
The ``id`` of the service used to generate the CSRF tokens. Symfony provides a
516519
default service whose ID is ``security.csrf.token_manager``.
517520

518521
csrf_token_id
519-
~~~~~~~~~~~~~
522+
.............
520523

521524
**type**: ``string`` **default**: ``'logout'``
522525

0 commit comments

Comments
 (0)
0