diff options
| author | Karl O. Pinc <kop@meme.com> | 2014-08-12 21:56:26 -0500 |
|---|---|---|
| committer | Karl O. Pinc <kop@meme.com> | 2014-08-12 21:56:26 -0500 |
| commit | 81719b800cfea1c6fd68427ea1d9c0a2f3e6c1dd (patch) | |
| tree | cafe7fbaf0c66c4686e8e9151a863b4ec6c729ba /docs/api | |
| parent | 5cf18393fbe9084e4b079a1136ed5de46ad89969 (diff) | |
| download | pyramid-81719b800cfea1c6fd68427ea1d9c0a2f3e6c1dd.tar.gz pyramid-81719b800cfea1c6fd68427ea1d9c0a2f3e6c1dd.tar.bz2 pyramid-81719b800cfea1c6fd68427ea1d9c0a2f3e6c1dd.zip | |
Docs: Make clear that a userid need not be a principal.
Diffstat (limited to 'docs/api')
| -rw-r--r-- | docs/api/request.rst | 10 |
1 files changed, 6 insertions, 4 deletions
diff --git a/docs/api/request.rst b/docs/api/request.rst index 77d80f6d6..3a32fd938 100644 --- a/docs/api/request.rst +++ b/docs/api/request.rst @@ -194,10 +194,12 @@ .. versionadded:: 1.5 A property which returns the list of 'effective' :term:`principal` - identifiers for this request. This will include the userid of the - currently authenticated user if a user is currently authenticated. If no - :term:`authentication policy` is in effect, this will return a sequence - containing only the :attr:`pyramid.security.Everyone` principal. + identifiers for this request. This list typically includes the + :term:`userid` of the currently authenticated user if a user is + currently authenticated, but this depends on the + :term:`authentication policy` in effect. If no :term:`authentication + policy` is in effect, this will return a sequence containing only the + :attr:`pyramid.security.Everyone` principal. .. method:: invoke_subrequest(request, use_tweens=False) |