diff options
| author | Michael Merickel <michael@merickel.org> | 2014-08-13 10:48:22 -0500 |
|---|---|---|
| committer | Michael Merickel <michael@merickel.org> | 2014-08-13 10:48:22 -0500 |
| commit | fe83c6bfdab16818cb434d95a09bd6510b43aa24 (patch) | |
| tree | 74564ce2085b37a78bcf9d4041138b0fface8890 /docs/glossary.rst | |
| parent | 03e95958a9c2b9042e55bc55e4cdb193649857ef (diff) | |
| download | pyramid-fe83c6bfdab16818cb434d95a09bd6510b43aa24.tar.gz pyramid-fe83c6bfdab16818cb434d95a09bd6510b43aa24.tar.bz2 pyramid-fe83c6bfdab16818cb434d95a09bd6510b43aa24.zip | |
some tweaks to the usage of userid in the docs
Diffstat (limited to 'docs/glossary.rst')
| -rw-r--r-- | docs/glossary.rst | 15 |
1 files changed, 7 insertions, 8 deletions
diff --git a/docs/glossary.rst b/docs/glossary.rst index eb57f3d0d..ef207a4bb 100644 --- a/docs/glossary.rst +++ b/docs/glossary.rst @@ -287,22 +287,21 @@ Glossary principal A *principal* is a string or unicode object representing an - entity, typically a user or group, having zero or more - :term:`permissions <permission>`. Principals are provided by an + entity, typically a user or group. Principals are provided by an :term:`authentication policy`. For example, if a user had the - user id "bob", and Bob was part of two groups named "group foo" + :term:`userid` `"bob"`, and was part of two groups named `"group foo"` and "group bar", the request might have information attached to it that would indicate that Bob was represented by three - principals: "bob", "group foo" and "group bar". + principals: `"bob"`, `"group foo"` and `"group bar"`. userid - A *userid* is a a string or unicode object used to identify and - authenticate a real-world user, often a person. A userid is + A *userid* is a string or unicode object 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>`. The default behavior of the authentication policies :app:`Pyramid` provides is to - return the user's userid as one of the user's principals, but a - userid need not be a principal. + return the user's userid as a principal, but this is not strictly + necessary in custom policies that define their principals differently. authorization policy An authorization policy in :app:`Pyramid` terms is a bit of |
