From d6b11b0abbf3e841dca7b57b4c56404bf089d48d Mon Sep 17 00:00:00 2001 From: Tim Graham Date: Thu, 5 Sep 2013 05:56:03 -0400 Subject: [PATCH] [1.5.x] Fixed #20900 -- Documented RemoteUserBackend.authenticate Backport of 7b62b80693 from master --- docs/howto/auth-remote-user.txt | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/docs/howto/auth-remote-user.txt b/docs/howto/auth-remote-user.txt index d59bb25a853..09ae92822b1 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