Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Fixed #20900 -- Documented RemoteUserBackend.authenticate

  • Loading branch information...
commit 7b62b80693d57f4bfd7a2f045bfd5c2f787601f8 1 parent bab039d
@timgraham timgraham authored
Showing with 11 additions and 0 deletions.
  1. +11 −0 docs/howto/auth-remote-user.txt
View
11 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
Please sign in to comment.
Something went wrong with that request. Please try again.