summaryrefslogtreecommitdiff
path: root/docs/api/security.rst
diff options
context:
space:
mode:
authorChris McDonough <chrism@agendaless.com>2009-05-27 04:52:51 +0000
committerChris McDonough <chrism@agendaless.com>2009-05-27 04:52:51 +0000
commita1a9fb7128c935848b17c0ce6586991098a17f07 (patch)
tree5160f28be92202033c693caa335f8b9cda3c6379 /docs/api/security.rst
parent08ead74d05e25f58c83712f6f8651484ddc983d0 (diff)
downloadpyramid-a1a9fb7128c935848b17c0ce6586991098a17f07.tar.gz
pyramid-a1a9fb7128c935848b17c0ce6586991098a17f07.tar.bz2
pyramid-a1a9fb7128c935848b17c0ce6586991098a17f07.zip
Merge authchanges branch to trunk.
Diffstat (limited to 'docs/api/security.rst')
-rw-r--r--docs/api/security.rst27
1 files changed, 11 insertions, 16 deletions
diff --git a/docs/api/security.rst b/docs/api/security.rst
index 5990f1809..77b60f5d0 100644
--- a/docs/api/security.rst
+++ b/docs/api/security.rst
@@ -8,14 +8,21 @@
API Functions
~~~~~~~~~~~~~
-.. autofunction:: authenticated_userid
+.. autofunction:: authenticated_userid(context, request)
-.. autofunction:: effective_principals
+.. autofunction:: effective_principals(context, request)
.. autofunction:: has_permission
.. autofunction:: principals_allowed_by_permission
+.. autofunction:: forget
+
+.. autofunction:: remember
+
+.. autofunction:: view_execution_permitted
+
+
Constants
~~~~~~~~~
@@ -29,8 +36,8 @@ Constants
The special principal id named 'Authenticated'. This principal id
is granted to all requests which contain any other non-Everyone
- principal id (according to the security policy). Its actual value
- is the string 'system.Authenticated'.
+ principal id (according to the :term:`authentication policy`).
+ Its actual value is the string 'system.Authenticated'.
.. attribute:: ALL_PERMISSIONS
@@ -73,15 +80,3 @@ Return Values
.. autoclass:: Allowed
:members:
-.. _security_policies_api_section:
-
-Security Policies
-~~~~~~~~~~~~~~~~~
-
-.. autofunction:: WhoACLSecurityPolicy
-
-.. autofunction:: WhoInheritingACLSecurityPolicy
-
-.. autofunction:: RemoteUserACLSecurityPolicy
-
-.. autofunction:: RemoteUserInheritingACLSecurityPolicy