diff options
| author | Tim Graham <timograham@gmail.com> | 2013-09-05 05:56:03 -0400 |
|---|---|---|
| committer | Tim Graham <timograham@gmail.com> | 2013-09-05 05:56:03 -0400 |
| commit | 7b62b80693d57f4bfd7a2f045bfd5c2f787601f8 (patch) | |
| tree | 862ef099b31e033a617b8382ab22ff634a9d50c8 | |
| parent | bab039d74c09bfba378b7a9b4a0a6d974e20f792 (diff) | |
Fixed #20900 -- Documented RemoteUserBackend.authenticate
| -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 |