Commit d6b11b0a authored by Tim Graham's avatar Tim Graham
Browse files

[1.5.x] Fixed #20900 -- Documented RemoteUserBackend.authenticate 

Backport of 7b62b806 from master
parent 406fd9f9

docs/howto/auth-remote-user.txt

+11 −0
Original line number Diff line number Diff line
@@ -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