innov
/
django1
1
0
Fork 0
Code Issues Pull Requests 1 Projects Releases Wiki Activity

Fixed #20900 -- Documented RemoteUserBackend.authenticate

This commit is contained in:
Tim Graham 2013-09-05 05:56:03 -04:00
parent bab039d74c
commit 7b62b80693
1 changed files with 11 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
docs/howto/auth-remote-user.txt
View File

@ -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