diff options
| author | Tim Graham <timograham@gmail.com> | 2013-09-05 05:56:03 -0400 |
|---|---|---|
| committer | Tim Graham <timograham@gmail.com> | 2013-09-05 06:32:50 -0400 |
| commit | 622d5c7650642a2f8daeaae6fac68d142330e993 (patch) | |
| tree | f08a8ea4f1189e2649a13e97c854bdafa0d155c4 /docs | |
| parent | 77cf0d6519c431d5411576ab5588c44971598b96 (diff) | |
[1.6.x] Fixed #20900 -- Documented RemoteUserBackend.authenticate
Backport of 7b62b80693 from master
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/howto/auth-remote-user.txt | 11 |
1 files changed, 11 insertions, 0 deletions
diff --git a/docs/howto/auth-remote-user.txt b/docs/howto/auth-remote-user.txt index d59bb25a85..09ae92822b 100644 --- a/docs/howto/auth-remote-user.txt +++ b/docs/howto/auth-remote-user.txt @@ -87,6 +87,17 @@ Attributes Methods ~~~~~~~ +.. method:: RemoteUserBackend.authenticate(remote_user) + + The username passed as ``remote_user`` is considered trusted. This method + simply returns the ``User`` object with the given username, creating a new + ``User`` object if :attr:`~RemoteUserBackend.create_unknown_user` is + ``True``. + + Returns ``None`` if :attr:`~RemoteUserBackend.create_unknown_user` is + ``False`` and a ``User`` object with the given username is not found in the + database. + .. method:: RemoteUserBackend.clean_username(username) Performs any cleaning on the ``username`` (e.g. stripping LDAP DN |