From d2d20b92158088e7d646393733092e67120058f0 Mon Sep 17 00:00:00 2001 From: Theron Luhn Date: Sun, 21 Jul 2019 09:20:44 -0700 Subject: Un-deprecate authenticated_userid. --- docs/glossary.rst | 12 ++++-------- docs/whatsnew-2.0.rst | 15 +++++++++------ 2 files changed, 13 insertions(+), 14 deletions(-) (limited to 'docs') diff --git a/docs/glossary.rst b/docs/glossary.rst index 5d374e0ec..b850f6e3e 100644 --- a/docs/glossary.rst +++ b/docs/glossary.rst @@ -298,18 +298,14 @@ Glossary foo` and `group bar`. userid - A *userid* is a string used to identify and authenticate - a real-world user or client. A userid is supplied to an - :term:`authentication policy` in order to discover the user's - :term:`principals `. In the authentication policies which - :app:`Pyramid` provides, the default behavior returns the user's userid as - a principal, but this is not strictly necessary in custom policies that - define their principals differently. + A *userid* is the string representation of an :term:`identity`. Just like + the identity, it should identify the user associated with the current + request. Oftentimes this is the ID of the user object in a database. identity An identity is an object identify the user associated with the current request. The identity can be any object, but should implement a - ``__str__`` method for logging and debugging purposes. + ``__str__`` method that outputs a corresponding :term:`userid`. security policy A security policy in :app:`Pyramid` terms is a bit of code which has an 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 ` has been removed; the ``permits`` method is passed an identity object. This change gives much more -- cgit v1.2.3