diff options
| author | Tim Graham <timograham@gmail.com> | 2013-05-13 11:02:30 -0700 |
|---|---|---|
| committer | Tim Graham <timograham@gmail.com> | 2013-05-13 11:02:30 -0700 |
| commit | 1708c8afb6f07417da192bae93a828065858fb3c (patch) | |
| tree | 46dc552fc4e42f21b699a32910c94f5f229ce1c7 /docs | |
| parent | 897e4eab6531cdbaf27c1b2a6716c86eb6ee1f5d (diff) | |
| parent | 1172bef998734ef78fc69927bed57364a868c44d (diff) | |
Merge pull request #1053 from makto/patch-1
Fixed #20394 - Clarified argument of get_user in docs
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/topics/auth/customizing.txt | 3 |
1 files changed, 2 insertions, 1 deletions
diff --git a/docs/topics/auth/customizing.txt b/docs/topics/auth/customizing.txt index b53bbe8211..56f3e60350 100644 --- a/docs/topics/auth/customizing.txt +++ b/docs/topics/auth/customizing.txt @@ -95,7 +95,8 @@ An authentication backend is a class that implements two required methods: optional permission related :ref:`authorization methods <authorization_methods>`. The ``get_user`` method takes a ``user_id`` -- which could be a username, -database ID or whatever -- and returns a ``User`` object. +database ID or whatever, but has to be the primary key of your ``User`` object +-- and returns a ``User`` object. The ``authenticate`` method takes credentials as keyword arguments. Most of the time, it'll just look like this:: |
