summaryrefslogtreecommitdiff
path: root/docs/whatsnew-2.0.rst
diff options
context:
space:
mode:
authorTheron Luhn <theron@luhn.com>2019-07-21 09:20:44 -0700
committerTheron Luhn <theron@luhn.com>2019-07-21 09:20:44 -0700
commitd2d20b92158088e7d646393733092e67120058f0 (patch)
tree74fd87877de8e43163b494bfc8be8167436ed02c /docs/whatsnew-2.0.rst
parent09960927167f80bb405da52c96775241c84a8682 (diff)
downloadpyramid-d2d20b92158088e7d646393733092e67120058f0.tar.gz
pyramid-d2d20b92158088e7d646393733092e67120058f0.tar.bz2
pyramid-d2d20b92158088e7d646393733092e67120058f0.zip
Un-deprecate authenticated_userid.
Diffstat (limited to 'docs/whatsnew-2.0.rst')
-rw-r--r--docs/whatsnew-2.0.rst15
1 files changed, 9 insertions, 6 deletions
diff --git a/docs/whatsnew-2.0.rst b/docs/whatsnew-2.0.rst
index 49400a937..446fcda21 100644
--- a/docs/whatsnew-2.0.rst
+++ b/docs/whatsnew-2.0.rst
@@ -40,12 +40,15 @@ The new security policy should implement
``security_policy`` argument of :class:`pyramid.config.Configurator` or
:meth:`pyramid.config.Configurator.set_security_policy`.
-The new security policy merges ``unauthenticated_userid`` and
-``authenticated_userid`` into an :term:`identity` object. This object can be
-of any shape, such as a simple ID string or an ORM object, but should have a
-string representation (i.e. a ``__str__`` method) useful for debugging.
-The identity can be accessed via
-:attr:`pyramid.request.Request.authenticated_identity`.
+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`.
+The object can be of any shape, such as a simple ID string or an ORM object,
+but should implement a ``__str__`` method that outputs a string identifying the
+current user, e.g. the ID of the user object in a database. The string
+representation is return as
+:attr:`pyramid.request.Request.authenticated_userid`.
+(:attr:`pyramid.request.Request.unauthenticated_userid` has been deprecated.)
The concept of :term:`principals <principal>` has been removed; the
``permits`` method is passed an identity object. This change gives much more