From 6360db290cde04a5cd40b614a5da2daf9b23f238 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Miro=20Hron=C4=8Dok?= Date: Tue, 3 May 2016 21:56:10 +0200 Subject: [PATCH] Document `keyword` variable of TokenAuthentication --- docs/api-guide/authentication.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/api-guide/authentication.md b/docs/api-guide/authentication.md index 06d043b6c5e..5568ed0c960 100644 --- a/docs/api-guide/authentication.md +++ b/docs/api-guide/authentication.md @@ -143,6 +143,8 @@ For clients to authenticate, the token key should be included in the `Authorizat Authorization: Token 9944b09199c62bcf9418ad846dd0e4bbdfc6ee4b +**Note:** If you want to use a different keyword in the header, such as `Bearer`, simply subclass `TokenAuthentication` and set the `keyword` class variable. + If successfully authenticated, `TokenAuthentication` provides the following credentials. * `request.user` will be a Django `User` instance.