diff options
| author | Karl O. Pinc <kop@meme.com> | 2014-08-12 20:49:11 -0500 |
|---|---|---|
| committer | Karl O. Pinc <kop@meme.com> | 2014-08-12 20:49:11 -0500 |
| commit | 5cf18393fbe9084e4b079a1136ed5de46ad89969 (patch) | |
| tree | a93ed5cffa6a8d7345dd620de5bc0633b277e0f4 /docs | |
| parent | 3587a53dc28b8f6411816ccd7fd8fdee0d88acb4 (diff) | |
| download | pyramid-5cf18393fbe9084e4b079a1136ed5de46ad89969.tar.gz pyramid-5cf18393fbe9084e4b079a1136ed5de46ad89969.tar.bz2 pyramid-5cf18393fbe9084e4b079a1136ed5de46ad89969.zip | |
Docs: Introduce the concept of "userid" into the glossary.
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/glossary.rst | 24 |
1 files changed, 17 insertions, 7 deletions
diff --git a/docs/glossary.rst b/docs/glossary.rst index deb4c1c8b..eb57f3d0d 100644 --- a/docs/glossary.rst +++ b/docs/glossary.rst @@ -286,13 +286,23 @@ Glossary :term:`authorization policy`. principal - A *principal* is a string or unicode object representing a userid - or a group id. It is 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" 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". + 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 + :term:`authentication policy`. For example, if a user had the + user id "bob", and Bob 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". + + 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 + 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. authorization policy An authorization policy in :app:`Pyramid` terms is a bit of |
