Hide the token table from the admin panel in Django REST Framework

Question

I'm using Django REST Framework and Django-OAuth-toolkit to enable OAuth2 authentication in my application.

Since after using OAuth2, I no more need token-based authentication and hence no token table/model.

Sometimes it makes me confused after seeing two different modules for handling token.

Therefore, I want to remove/hide Token table from the admin panel of Django.

Here is my settings.py file

REST_FRAMEWORK = {
    'DEFAULT_AUTHENTICATION_CLASSES': (
        'oauth2_provider.contrib.rest_framework.OAuth2Authentication'
    ),
    'DEFAULT_PERMISSION_CLASSES': [
        'rest_framework.permissions.IsAuthenticated'
    ],
    'DEFAULT_PAGINATION_CLASS': 'rest_framework.pagination.PageNumberPagination',
    'PAGE_SIZE': 10
}

I have removed Token based authentication but still Token table is there in the admin panel

Oli · Accepted Answer · 2022-06-10 08:25:35Z

19

You don't have to remove rest_framework.authtoken, you can just kick out its registered admin.

This answer likely doesn't apply to you but if you want to carry on using authtokens and just make them hidden from the Admin, you can add the following to one of your existing admin.py files:

try:
    from rest_framework.authtoken.models import TokenProxy as DRFToken
except ImportError:
    from rest_framework.authtoken.models import Token as DRFToken

admin.site.unregister(DRFToken)

Why the ugly code? It's to cope with a 2020 edit whereby the ModelAdmin used here is registered against a proxy model to another which picks the User's PK as its main primary key (for URLs, etc) rather than the database ID of the Token. These are one-to-one mapped, so it makes some sense.

If you know you're only supporting DRF 3.12.0 and newer, you can hack this down to TokenProxy.

edited Jun 10, 2022 at 8:25

answered Aug 15, 2019 at 13:01

Oli

241k67 gold badges227 silver badges305 bronze badges

Sign up to request clarification or add additional context in comments.

4 Comments

Carl Over a year ago

I tried this solution but it's throwing a NotRegistered error even when django.contrib.auth is listed first in INSTALLED_APPS

Allen Shaw Over a year ago

You should unregister TokenProxy admin.site.unregister(TokenProxy)

Julien Salinas Over a year ago

Thanks @AllenShaw, unregistering TokenProxy (admin.site.unregister(TokenProxy)) worked for me.

Webucator Over a year ago

Unregistering Token worked for me in Django 3.1, but did not work in Django 4.0. It through the NotRegistered error. Unregistering TokenProxy does work in Django 4.0.

Ahmed Safadi · Accepted Answer · 2021-03-14 10:58:35Z

9

from rest_framework.authtoken.models import TokenProxy
admin.site.unregister(TokenProxy)

answered Mar 14, 2021 at 10:58

Ahmed Safadi

4,62041 silver badges35 bronze badges

Comments

Jet Ezra · Accepted Answer · 2021-07-28 18:00:23Z

4

Get to any registered app's admin.py and add the below lines.

from rest_framework.authtoken.models import TokenProxy
admin.site.unregister(TokenProxy)

Atleast, this works as per 2021 using Django 3.1.7.

answered Jul 28, 2021 at 18:00

Jet Ezra

1842 silver badges10 bronze badges

1 Comment

Webucator Over a year ago

This works in Django 4.0 as well.

user9919969 · Accepted Answer · 2018-08-06 15:55:02Z

2

You have to remove rest_framework.authtoken from INSTALLED_APPS

See the docs

answered Aug 6, 2018 at 15:55

user9919969

1 Comment

SaturnFromTitan Over a year ago

true, you don't "have to", but if you want to, this seems to be a reasonable solution. It worked well in my case. Thanks!

Kuntal Samanta Capital Numbers · Accepted Answer · 2021-05-19 10:59:02Z

1

from rest_framework.authtoken.models import Token
admin.site.unregister(Token)

if you do the above one you will get "raise NotRegistered('The model %s is not registered' % model.name) django.contrib.admin.sites.NotRegistered: The model Token is not registered"

So please follow this below approch

from rest_framework.authtoken.models import TokenProxy
admin.site.unregister(TokenProxy)

answered May 19, 2021 at 10:59

Kuntal Samanta Capital Numbers

312 bronze badges

Comments

Rathnakara S · Accepted Answer · 2024-03-17 09:37:26Z

For anyone still facing this error raise NotRegistered('The model %s is not registered' % model.__name__), even after doing either

admin.site.unregister(TokenProxy) or admin.site.unregister(Token)

This can happen due to the order in which Django initializes applications and their components. When your admin.py is processed, it might be that TokenProxy or Token hasn't been registered yet with the admin site, leading to the NotRegistered error.

A solution to this issue involves ensuring your unregister call occurs after all apps, including the rest_framework.authtoken, have been fully initialized. One way to achieve this is by using Django's AppConfig.ready method, which allows you to execute code once Django is ready and all models are loaded.

Here's how you can do it:

Step 1: Create or Modify an AppConfig for Your Application

If your application doesn't already have a custom AppConfig, create one. This involves creating a subclass of django.apps.AppConfig in your application's apps.py file. If apps.py doesn't exist, create it inside your application directory. Here's an example:

from django.apps import AppConfig

class MyAppConfig(AppConfig):
    name = 'your_app_name'  # Replace 'your_app_name' with the name of your app
    verbose_name = "My Application"

    def ready(self):
        # This method will be executed once Django is fully initialized
        from django.contrib import admin
        from rest_framework.authtoken.models import TokenProxy #or Token based on your Django version
        try:
            admin.site.unregister(TokenProxy)
        except admin.sites.NotRegistered:
            pass

Step 2: Update Your Application's Configuration in settings.py

In your settings.py, update the INSTALLED_APPS entry for your application to use the new AppConfig. This involves using the full path to your AppConfig class:

INSTALLED_APPS = [
    # other apps
    'your_app_name.apps.MyAppConfig',  # Replace with your AppConfig path
    # other apps
]

Jasir · Accepted Answer · 2025-09-25 21:32:09Z

1

For Django==5.2.5

from rest_framework.authtoken.models import TokenProxy
admin.site.unregister(TokenProxy)

I got error "django.contrib.admin.exceptions.NotRegistered: The model TokenProxy is not registered" when i unregister like above

What worked for me that i have added import for TokenAdmin so it wored for me

from rest_framework.authtoken.admin import TokenAdmin
from rest_framework.authtoken.models import TokenProxy
admin.site.unregister(TokenProxy)

answered Sep 25 at 21:32

Jasir

7638 silver badges17 bronze badges

1 Comment

SolutionizeIT Freelance Sep 25 at 21:33

Great!! it working for me too

syk1k · Accepted Answer · 2021-10-11 11:25:46Z

0

This should normally work

from rest_framework.authtoken.admin import (
    TokenProxy
)

admin.site.unregister(TokenProxy)

answered Oct 11, 2021 at 11:25

syk1k

215 bronze badges

Collectives™ on Stack Overflow

Hide the token table from the admin panel in Django REST Framework

8 Answers 8

4 Comments

Comments

1 Comment

1 Comment

Comments

Comments

1 Comment

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

8 Answers 8

4 Comments

Comments

1 Comment

1 Comment

Comments

Comments

1 Comment

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related