diff options
| author | Bert JW Regeer <xistence@0x58.com> | 2020-07-05 20:45:21 -0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-07-05 20:45:21 -0700 |
| commit | 5269b28e728a470b94f194bf8febd46278b1f356 (patch) | |
| tree | a7b0f7e1f227bae84baf33240d7ea1831c894ce7 /docs/narr/viewconfig.rst | |
| parent | 48a04855ad4f1f1ae6af934090f35a4ad035ed67 (diff) | |
| parent | 5f37acda1c8af7cb288e792e2c82f728fe254818 (diff) | |
| download | pyramid-5269b28e728a470b94f194bf8febd46278b1f356.tar.gz pyramid-5269b28e728a470b94f194bf8febd46278b1f356.tar.bz2 pyramid-5269b28e728a470b94f194bf8febd46278b1f356.zip | |
Merge pull request #3598 from merwok/feature/is_authenticated
Add Request.is_authenticated and is_authenticated predicate
Diffstat (limited to 'docs/narr/viewconfig.rst')
| -rw-r--r-- | docs/narr/viewconfig.rst | 12 |
1 files changed, 12 insertions, 0 deletions
diff --git a/docs/narr/viewconfig.rst b/docs/narr/viewconfig.rst index b43ebb93e..de82fc075 100644 --- a/docs/narr/viewconfig.rst +++ b/docs/narr/viewconfig.rst @@ -494,6 +494,15 @@ configured view. .. versionadded:: 1.4a3 +``is_authenticated`` + This value, if specified, must be either ``True`` or ``False``. + If it is specified and ``True``, only a request from an authenticated user, as + determined by the :term:`security policy` in use, will satisfy the predicate. + If it is specified and ``False``, only a request from a user who is not + authenticated will satisfy the predicate. + + .. versionadded:: 2.0 + ``effective_principals`` If specified, this value should be a :term:`principal` identifier or a sequence of principal identifiers. If the @@ -505,6 +514,9 @@ configured view. .. versionadded:: 1.4a4 + .. deprecated:: 2.0 + Use ``is_authenticated`` or a custom predicate. + ``custom_predicates`` If ``custom_predicates`` is specified, it must be a sequence of references to custom predicate callables. Custom predicates can be combined with |