diff options
| author | Mjumbe Wawatu Poe | 2012-09-07 14:23:53 -0400 |
|---|---|---|
| committer | Mjumbe Wawatu Poe | 2012-09-07 14:23:53 -0400 |
| commit | 3b1404bd7d37d8c60cf45071852f86eea8d4c68f (patch) | |
| tree | c7e12174dab6415cd0ce21d578d553d7cf627f5e /docs/api-guide/authentication.md | |
| parent | 36cd91bbbe6bc0aeef9b1eb711415988f5c4e501 (diff) | |
| download | django-rest-framework-3b1404bd7d37d8c60cf45071852f86eea8d4c68f.tar.bz2 | |
Rename the default token class to "BasicToken"
Diffstat (limited to 'docs/api-guide/authentication.md')
| -rw-r--r-- | docs/api-guide/authentication.md | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/docs/api-guide/authentication.md b/docs/api-guide/authentication.md index c5e4c1cc..c5b7ac9c 100644 --- a/docs/api-guide/authentication.md +++ b/docs/api-guide/authentication.md @@ -76,7 +76,7 @@ This policy uses [HTTP Authentication][basicauth] with a custom authentication s If successfully authenticated, `TokenAuthentication` provides the following credentials. * `request.user` will be a `django.contrib.auth.models.User` instance. -* `request.auth` will be a `djangorestframework.tokenauth.models.Token` instance. +* `request.auth` will be a `djangorestframework.tokenauth.models.BasicToken` instance. To use the `TokenAuthentication` scheme, you must have a token model. Django REST Framework comes with a minimal default token model. To use it, include `djangorestframework.tokenauth` in your installed applications. To use your own token model, subclass the `djangorestframework.tokenauth.authentication.TokenAuthentication` class and specify a `model` attribute that references your custom token model. The token model must provide `user`, `key`, and `revoked` attributes. For convenience, the `djangorestframework.tokenauth.models.BaseToken` abstract model implements this minimum contract, and also randomly populates the key field when none is provided. |