summaryrefslogtreecommitdiff
path: root/docs/api/authentication.rst
diff options
context:
space:
mode:
authorMichael Merickel <michael@merickel.org>2019-09-30 22:23:02 -0500
committerGitHub <noreply@github.com>2019-09-30 22:23:02 -0500
commit849463d3c2f5ad2c89b3d10a2abce63e4892082d (patch)
tree5bc507d427d8d2000c59ad7837cc03099decf1b5 /docs/api/authentication.rst
parentada0a977d9190520c21ffaf9500860db2f3a1b3e (diff)
parentcdb26610782176955cd8cfb0b3c3e242ca819f74 (diff)
downloadpyramid-849463d3c2f5ad2c89b3d10a2abce63e4892082d.tar.gz
pyramid-849463d3c2f5ad2c89b3d10a2abce63e4892082d.tar.bz2
pyramid-849463d3c2f5ad2c89b3d10a2abce63e4892082d.zip
Merge pull request #3465 from luhn/security-policy
Security policy implementation
Diffstat (limited to 'docs/api/authentication.rst')
-rw-r--r--docs/api/authentication.rst36
1 files changed, 21 insertions, 15 deletions
diff --git a/docs/api/authentication.rst b/docs/api/authentication.rst
index 57f32327a..f3a25ee64 100644
--- a/docs/api/authentication.rst
+++ b/docs/api/authentication.rst
@@ -3,10 +3,30 @@
:mod:`pyramid.authentication`
--------------------------------
+Helper Classes
+~~~~~~~~~~~~~~
+
+.. automodule:: pyramid.authentication
+
+ .. autoclass:: SessionAuthenticationHelper
+ :members:
+
+ .. autoclass:: AuthTktCookieHelper
+ :members:
+
+Helper Functions
+~~~~~~~~~~~~~~~~
+
+ .. autofunction:: extract_http_basic_credentials
+
+ .. autoclass:: HTTPBasicCredentials
+ :members:
+
Authentication Policies
~~~~~~~~~~~~~~~~~~~~~~~
-.. automodule:: pyramid.authentication
+Authentication policies have been deprecated by the new security system. See
+:ref:`upgrading_auth` for more information.
.. autoclass:: AuthTktAuthenticationPolicy
:members:
@@ -27,17 +47,3 @@ Authentication Policies
.. autoclass:: RepozeWho1AuthenticationPolicy
:members:
:inherited-members:
-
-Helper Classes
-~~~~~~~~~~~~~~
-
- .. autoclass:: AuthTktCookieHelper
- :members:
-
- .. autoclass:: HTTPBasicCredentials
- :members:
-
-Helper Functions
-~~~~~~~~~~~~~~~~
-
- .. autofunction:: extract_http_basic_credentials