django-guardian
is an implementation of per-object permissions on top of Django’s authorization backend. Read an introduction to per-object permissions on djangoadvent articles.
Online documentation is available at https://django-guardian.readthedocs.io/.
To install django-guardian
into your project run:
TIP: Not using a package manager like
uv
orpoetry
for your django project? You probably should try them :). In the meantime,pip install django-guardian
works just fine too.
We need to hook django-guardian
into our project.
guardian
into your INSTALLED_APPS
at settings module:INSTALLED_APPS = ( ... 'guardian', )
settings.py
:AUTHENTICATION_BACKENDS = ( 'django.contrib.auth.backends.ModelBackend', 'guardian.backends.ObjectPermissionBackend', )
guardian
database tables by running:After installation and project hooks we can finally use object permissions with Django.
Lets start really quickly:
>>> from django.contrib.auth.models import User, Group >>> jack = User.objects.create_user('jack', 'jack@example.com', 'topsecretagentjack') >>> admins = Group.objects.create(name='admins') >>> jack.has_perm('change_group', admins) False >>> from guardian.shortcuts import assign_perm >>> assign_perm('change_group', jack, obj=admins) <UserObjectPermission: admins | jack | change_group> >>> jack.has_perm('change_group', admins) True
Of course our agent jack here would not be able to change_group globally:
>>> jack.has_perm('change_group') False
Replace admin.ModelAdmin
with GuardedModelAdmin
for those models which should have object permissions support within admin panel.
For example:
from django.contrib import admin from myapp.models import Author from guardian.admin import GuardedModelAdmin # Old way: #class AuthorAdmin(admin.ModelAdmin): # pass # With object permissions support class AuthorAdmin(GuardedModelAdmin): pass admin.site.register(Author, AuthorAdmin)Django Unfold integration
Users of django-unfold
will find that guardian
is supported out of the box via a contrib
module.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4