From f9fba4fb3e6f6906821ed0f39e6d11cb0f26ce9d Mon Sep 17 00:00:00 2001 From: Theron Luhn Date: Sun, 26 May 2019 10:13:49 -0700 Subject: API docs. --- docs/api/authentication.rst | 35 +++++++++++++++++++---------------- docs/api/authorization.rst | 3 +++ 2 files changed, 22 insertions(+), 16 deletions(-) (limited to 'docs/api') diff --git a/docs/api/authentication.rst b/docs/api/authentication.rst index 57f32327a..835d46de0 100644 --- a/docs/api/authentication.rst +++ b/docs/api/authentication.rst @@ -3,11 +3,28 @@ :mod:`pyramid.authentication` -------------------------------- -Authentication Policies -~~~~~~~~~~~~~~~~~~~~~~~ +Helper Classes +~~~~~~~~~~~~~~ .. automodule:: pyramid.authentication + .. autoclass:: SessionAuthenticationHelper + :members: + + .. autoclass:: AuthTktCookieHelper + :members: + + .. autoclass:: HTTPBasicCredentials + :members: + +Helper Functions +~~~~~~~~~~~~~~~~ + + .. autofunction:: extract_http_basic_credentials + +Authentication Policies +~~~~~~~~~~~~~~~~~~~~~~~ + .. autoclass:: AuthTktAuthenticationPolicy :members: :inherited-members: @@ -27,17 +44,3 @@ Authentication Policies .. autoclass:: RepozeWho1AuthenticationPolicy :members: :inherited-members: - -Helper Classes -~~~~~~~~~~~~~~ - - .. autoclass:: AuthTktCookieHelper - :members: - - .. autoclass:: HTTPBasicCredentials - :members: - -Helper Functions -~~~~~~~~~~~~~~~~ - - .. autofunction:: extract_http_basic_credentials diff --git a/docs/api/authorization.rst b/docs/api/authorization.rst index 5f5435b94..c6b3d090e 100644 --- a/docs/api/authorization.rst +++ b/docs/api/authorization.rst @@ -5,5 +5,8 @@ .. automodule:: pyramid.authorization + .. autoclass:: ACLHelper + :members: + .. autoclass:: ACLAuthorizationPolicy -- cgit v1.2.3 From 5d79e3f232dfbbda1a88a3dac9f990773d1699b7 Mon Sep 17 00:00:00 2001 From: Theron Luhn Date: Sun, 23 Jun 2019 12:03:25 -0700 Subject: Make sure Configator.set_security_policy is in docs. --- docs/api/config.rst | 1 + 1 file changed, 1 insertion(+) (limited to 'docs/api') diff --git a/docs/api/config.rst b/docs/api/config.rst index 4fe0e855d..a925f42d9 100644 --- a/docs/api/config.rst +++ b/docs/api/config.rst @@ -35,6 +35,7 @@ :methodcategory:`Using Security` + .. automethod:: set_security_policy .. automethod:: set_authentication_policy .. automethod:: set_authorization_policy .. automethod:: set_default_csrf_options -- cgit v1.2.3 From 14d569ea34409ed796296f860f03b8403859412f Mon Sep 17 00:00:00 2001 From: Theron Luhn Date: Sun, 23 Jun 2019 12:19:06 -0700 Subject: Deprecation notices. --- docs/api/request.rst | 17 ++++++++++++++--- 1 file changed, 14 insertions(+), 3 deletions(-) (limited to 'docs/api') diff --git a/docs/api/request.rst b/docs/api/request.rst index e7b2edc9a..8e0f77b87 100644 --- a/docs/api/request.rst +++ b/docs/api/request.rst @@ -166,7 +166,11 @@ .. attribute:: authenticated_userid - .. versionadded:: 1.5 + .. deprecated:: 2.0 + + ``authenticated_userid`` has been replaced by + :attr:`authenticated_identity` in the new security system. See + :ref:`upgrading_auth` for more information. A property which returns the :term:`userid` of the currently authenticated user or ``None`` if there is no :term:`authentication @@ -178,7 +182,11 @@ .. attribute:: unauthenticated_userid - .. versionadded:: 1.5 + .. deprecated:: 2.0 + + ``unauthenticated_userid`` has been replaced by + :attr:`authenticated_identity` in the new security system. See + :ref:`upgrading_auth` for more information. A property which returns a value which represents the *claimed* (not verified) :term:`userid` of the credentials present in the @@ -193,7 +201,10 @@ .. attribute:: effective_principals - .. versionadded:: 1.5 + .. deprecated:: 2.0 + + The new security policy has removed the concept of principals. See + :ref:`upgrading_auth` for more information. A property which returns the list of 'effective' :term:`principal` identifiers for this request. This list typically includes the -- cgit v1.2.3 From c69994778de79041d703fd121ec9d1aaf8a6b7c8 Mon Sep 17 00:00:00 2001 From: Theron Luhn Date: Sat, 13 Jul 2019 10:10:46 -0700 Subject: Improve authn/authz API docs. --- docs/api/authentication.rst | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) (limited to 'docs/api') diff --git a/docs/api/authentication.rst b/docs/api/authentication.rst index 835d46de0..f3a25ee64 100644 --- a/docs/api/authentication.rst +++ b/docs/api/authentication.rst @@ -14,17 +14,20 @@ Helper Classes .. autoclass:: AuthTktCookieHelper :members: - .. autoclass:: HTTPBasicCredentials - :members: - Helper Functions ~~~~~~~~~~~~~~~~ .. autofunction:: extract_http_basic_credentials + .. autoclass:: HTTPBasicCredentials + :members: + Authentication Policies ~~~~~~~~~~~~~~~~~~~~~~~ +Authentication policies have been deprecated by the new security system. See +:ref:`upgrading_auth` for more information. + .. autoclass:: AuthTktAuthenticationPolicy :members: :inherited-members: -- cgit v1.2.3