From 5ae49a4ec4ccfdab13bc848ecd175d44ecaf4ed1 Mon Sep 17 00:00:00 2001
From: Tom Christie
Date: Wed, 17 Oct 2012 14:59:53 +0100
Subject: Add docs for 401 vs 403 responses

---
 rest_framework/authentication.py | 8 ++++++++
 1 file changed, 8 insertions(+)

(limited to 'rest_framework')

diff --git a/rest_framework/authentication.py b/rest_framework/authentication.py
index 30c78ebc..e557abed 100644
--- a/rest_framework/authentication.py
+++ b/rest_framework/authentication.py
@@ -21,6 +21,14 @@ class BaseAuthentication(object):
         """
         raise NotImplementedError(".authenticate() must be overridden.")
 
+    def authenticate_header(self, request):
+        """
+        Return a string to be used as the value of the `WWW-Authenticate`
+        header in a `401 Unauthenticated` response, or `None` if the
+        authentication scheme should return `403 Permission Denied` responses.
+        """
+        pass
+
 
 class BasicAuthentication(BaseAuthentication):
     """
-- 
cgit v1.2.3