summaryrefslogtreecommitdiff
path: root/docs/whatsnew-2.0.rst
diff options
context:
space:
mode:
authorMichael Merickel <michael@merickel.org>2020-11-01 18:15:49 -0600
committerGitHub <noreply@github.com>2020-11-01 18:15:49 -0600
commit68a6cb1dba7944f1e214ca62ce700e3f7ddf618d (patch)
treea1d646c7feefb9a28347b9826829d4ad59730c46 /docs/whatsnew-2.0.rst
parentc6772eadc18056b5eed90f6a694e53579ba403a4 (diff)
parent139462d451a1c35679b464690953333dd95389a1 (diff)
downloadpyramid-68a6cb1dba7944f1e214ca62ce700e3f7ddf618d.tar.gz
pyramid-68a6cb1dba7944f1e214ca62ce700e3f7ddf618d.tar.bz2
pyramid-68a6cb1dba7944f1e214ca62ce700e3f7ddf618d.zip
Merge pull request #3620 from luhn/identity-rename
Rename `ISecurityPolicy.authenticated_identity` to `identity`
Diffstat (limited to 'docs/whatsnew-2.0.rst')
-rw-r--r--docs/whatsnew-2.0.rst8
1 files changed, 3 insertions, 5 deletions
diff --git a/docs/whatsnew-2.0.rst b/docs/whatsnew-2.0.rst
index a58f317d7..906529d6b 100644
--- a/docs/whatsnew-2.0.rst
+++ b/docs/whatsnew-2.0.rst
@@ -47,7 +47,7 @@ signature.
The new security policy adds the concept of an :term:`identity`, which is an
object representing the user associated with the current request. The identity
-can be accessed via :attr:`pyramid.request.Request.authenticated_identity`.
+can be accessed via :attr:`pyramid.request.Request.identity`.
The object can be of any shape, such as a simple ID string or an ORM object.
The concept of :term:`principals <principal>` has been removed; the
@@ -89,10 +89,8 @@ For further documentation on implementing security policies, see
Behavior of the Legacy System
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-Legacy authentication and authorization policies will continue to function as
-normal, as well as all related :class:`pyramid.request.Request` properties.
-The new :attr:`pyramid.request.Request.authenticated_identity` property will
-output the same result as :attr:`pyramid.request.Request.authenticated_userid`.
+Legacy authentication and authorization policies will continue to function as normal, as well as all related :class:`pyramid.request.Request` properties.
+The new :attr:`pyramid.request.Request.identity` property will output the same result as :attr:`pyramid.request.Request.authenticated_userid`.
If using a security policy, :attr:`pyramid.request.Request.unauthenticated_userid` will return the same value as :attr:`pyramid.request.Request.authenticated_userid`.
:attr:`pyramid.request.Request.effective_principals` will always return a one-element list containing the :data:`pyramid.authorization.Everyone` principal, as there is no equivalent in the new security policy.