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:55 -0400 |
| commit | d6b11b0abbf3e841dca7b57b4c56404bf089d48d (patch) | |
| tree | 7e0e6f99166e2f490f9a431435a8ea06547f22b7 | |
| parent | 406fd9f97f4b04212276e2e78d8216ef5a27a514 (diff) | |
[1.5.x] Fixed #20900 -- Documented RemoteUserBackend.authenticate
Backport of 7b62b80693 from master
| -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 |