diff options
| author | Theron Luhn <theron@luhn.com> | 2019-12-14 20:27:30 -0600 |
|---|---|---|
| committer | Theron Luhn <theron@luhn.com> | 2019-12-14 20:27:30 -0600 |
| commit | cd0b92d10bfbb38068c216ce44dde9732fa127a8 (patch) | |
| tree | 97082f115b2043dd4c3a56d617e8a27a6ac02653 /docs/api | |
| parent | 2cbb91b80438e6f5ec98d004eb5ac8c1650ad176 (diff) | |
| download | pyramid-cd0b92d10bfbb38068c216ce44dde9732fa127a8.tar.gz pyramid-cd0b92d10bfbb38068c216ce44dde9732fa127a8.tar.bz2 pyramid-cd0b92d10bfbb38068c216ce44dde9732fa127a8.zip | |
Update docs.
Diffstat (limited to 'docs/api')
| -rw-r--r-- | docs/api/request.rst | 20 |
1 files changed, 5 insertions, 15 deletions
diff --git a/docs/api/request.rst b/docs/api/request.rst index fb4b5caee..50703ff63 100644 --- a/docs/api/request.rst +++ b/docs/api/request.rst @@ -166,27 +166,17 @@ .. attribute:: authenticated_userid - .. versionchanged:: 2.0 - - ``authenticated_userid`` uses security policy or authn pol - see also :attr:`authenticated_identity` and - :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 - policy` in effect or there is no currently authenticated user. This - differs from :attr:`~pyramid.request.Request.unauthenticated_userid`, - because the effective authentication policy will have ensured that a - record associated with the :term:`userid` exists in persistent storage; - if it has not, this value will be ``None``. + authenticated user or ``None`` if there is no :term:`security policy` in + effect or there is no currently authenticated user. .. attribute:: unauthenticated_userid .. deprecated:: 2.0 - ``unauthenticated_userid`` has been replaced by - :attr:`authenticated_identity` in the new security system. See - :ref:`upgrading_auth` for more information. + ``unauthenticated_userid`` has been deprecated in version 2.0. Use + :attr:`authenticated_userid` or :attr:`authenticated_identity` + instead. 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 |