diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/narr/advanced-features.rst | 2 | ||||
| -rw-r--r-- | docs/narr/viewconfig.rst | 12 |
2 files changed, 13 insertions, 1 deletions
diff --git a/docs/narr/advanced-features.rst b/docs/narr/advanced-features.rst index 6e819ff5b..6f3b4e11b 100644 --- a/docs/narr/advanced-features.rst +++ b/docs/narr/advanced-features.rst @@ -34,7 +34,7 @@ For our example above, you can do this instead: .. code-block:: python :linenos: - @view_config(route_name="items", effective_principals=pyramid.authorization.Authenticated) + @view_config(route_name="items", is_authenticated=True) def auth_view(request): # do one thing 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 |