diff options
| author | Chris McDonough <chrism@plope.com> | 2012-10-28 23:17:31 -0400 |
|---|---|---|
| committer | Chris McDonough <chrism@plope.com> | 2012-10-28 23:17:31 -0400 |
| commit | c7337ba1b02915824cb33803993c8ba236ed23b9 (patch) | |
| tree | 9cfd4192d7a9b265da16856d9002471ed4f92e7f /docs | |
| parent | 4a6cca62ddf33580b1de210ef5ca54bfb2769243 (diff) | |
| download | pyramid-c7337ba1b02915824cb33803993c8ba236ed23b9.tar.gz pyramid-c7337ba1b02915824cb33803993c8ba236ed23b9.tar.bz2 pyramid-c7337ba1b02915824cb33803993c8ba236ed23b9.zip | |
- Added an ``effective_principals`` route and view predicate.
Diffstat (limited to 'docs')
| -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 752e6ad72..6373a8d26 100644 --- a/docs/narr/viewconfig.rst +++ b/docs/narr/viewconfig.rst @@ -431,6 +431,18 @@ configured view. .. versionadded:: 1.4a3 +``effective_principals`` + + If specified, this value should be a :term:`principal` identifier or a + sequence of principal identifiers. If the + :func:`pyramid.security.effective_principals` method indicates that every + principal named in the argument list is present in the current request, this + predicate will return True; otherwise it will return False. For example: + ``effective_principals=pyramid.security.Authenticated`` or + ``effective_principals=('fred', 'group:admins')``. + + .. versionadded:: 1.4a4 + ``custom_predicates`` If ``custom_predicates`` is specified, it must be a sequence of references to custom predicate callables. Use custom predicates when no set of |