summaryrefslogtreecommitdiff
path: root/docs/whatsnew-2.0.rst
diff options
context:
space:
mode:
authorTheron Luhn <theron@luhn.com>2020-10-13 23:08:00 -0700
committerTheron Luhn <theron@luhn.com>2020-10-13 23:08:00 -0700
commitab80ac7996bf792ddf3fbcce639e4b6714b401e6 (patch)
tree1b54439857877acda31c0460c0dfb92648daf0b8 /docs/whatsnew-2.0.rst
parentee7ca28cc51cf40d1190144834704e287c9fc72d (diff)
downloadpyramid-ab80ac7996bf792ddf3fbcce639e4b6714b401e6.tar.gz
pyramid-ab80ac7996bf792ddf3fbcce639e4b6714b401e6.tar.bz2
pyramid-ab80ac7996bf792ddf3fbcce639e4b6714b401e6.zip
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.