diff options
| author | Theron Luhn <theron@luhn.com> | 2019-07-21 09:20:44 -0700 |
|---|---|---|
| committer | Theron Luhn <theron@luhn.com> | 2019-07-21 09:20:44 -0700 |
| commit | d2d20b92158088e7d646393733092e67120058f0 (patch) | |
| tree | 74fd87877de8e43163b494bfc8be8167436ed02c /docs/glossary.rst | |
| parent | 09960927167f80bb405da52c96775241c84a8682 (diff) | |
| download | pyramid-d2d20b92158088e7d646393733092e67120058f0.tar.gz pyramid-d2d20b92158088e7d646393733092e67120058f0.tar.bz2 pyramid-d2d20b92158088e7d646393733092e67120058f0.zip | |
Un-deprecate authenticated_userid.
Diffstat (limited to 'docs/glossary.rst')
| -rw-r--r-- | docs/glossary.rst | 12 |
1 files changed, 4 insertions, 8 deletions
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 <principal>`. 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 |