diff options
| author | tom christie tom@tomchristie.com | 2011-02-19 13:12:35 +0000 |
|---|---|---|
| committer | tom christie tom@tomchristie.com | 2011-02-19 13:12:35 +0000 |
| commit | e4fff6ea6e5422af23c324897ed1cff8f8a6e903 (patch) | |
| tree | 030c0d0a02e25ffdef43781fbc815dbce48dd16d /docs/library/authenticators.rst | |
| parent | 57b3a372f2122d022f9d6f43818e5fe9d318ce03 (diff) | |
| download | django-rest-framework-e4fff6ea6e5422af23c324897ed1cff8f8a6e903.tar.bz2 | |
Clean up the docs
Diffstat (limited to 'docs/library/authenticators.rst')
| -rw-r--r-- | docs/library/authenticators.rst | 29 |
1 files changed, 2 insertions, 27 deletions
diff --git a/docs/library/authenticators.rst b/docs/library/authenticators.rst index ec49c246..407339f7 100644 --- a/docs/library/authenticators.rst +++ b/docs/library/authenticators.rst @@ -1,30 +1,5 @@ :mod:`authenticators` ===================== -.. module:: authenticators - -The authenticators module provides a standard set of authentication methods that can be plugged in to a :class:`.Resource`, as well as providing a template by which to write custom authentication methods. - -The base class --------------- - -All authenticators must subclass the :class:`BaseAuthenticator` class and override it's :func:`authenticate` method. - -.. class:: BaseAuthenticator - - .. method:: authenticate(request) - - Authenticate the request and return the authentication context or None. - - The default permission checking on :class:`.Resource` will use the allowed_methods attribute for permissions if the authentication context is not None, and use anon_allowed_methods otherwise. - - The authentication context is passed to the handler calls (eg :meth:`.Resource.get`, :meth:`.Resource.post` etc...) in order to allow them to apply any more fine grained permission checking at the point the response is being generated. - - This function must be overridden to be implemented. - -Provided authenticators ------------------------ - -.. note:: - - TODO - document this module properly +.. automodule:: authenticators + :members: |