Admin
GuardedModelAdmin
Bases: GuardedModelAdminMixin, ModelAdmin
Provide views for managing object permissions on the Django admin panel.
Extends the django.contrib.admin.ModelAdmin class.
It uses 'admin/guardian/model/change_form.html' as the
default change_form_template attribute which is required for proper
url (object permissions related) being shown at the model pages.
Attributes:
| Name | Type | Description |
|---|---|---|
obj_perms_manage_template |
str
|
Defaults to |
obj_perms_manage_user_template |
str
|
Defaults to |
obj_perms_manage_group_template |
str
|
Defaults to |
user_can_access_owned_objects_only |
bool
|
Defaults to |
user_can_access_owned_by_group_objects_only |
bool
|
Default: |
group_owned_objects_field |
str
|
Default: |
include_object_permissions_urls |
bool
|
Default: |
Warning
Setting user_can_access_owned_objects_only to True will NOT affect superusers!
Admins would still see all items.
Warning
Setting user_can_access_owned_by_group_objects_only to True will NOT affect superusers!
Admins would still see all items.
Example
# Just use GuardedModelAdmin instead of django.contrib.admin.ModelAdmin.
from django.contrib import admin
from guardian.admin import GuardedModelAdmin
from myapp.models import Author
class AuthorAdmin(GuardedModelAdmin):
pass
admin.site.register(Author, AuthorAdmin)
Source code in guardian/admin.py
427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 | |
GuardedModelAdminMixin
Mixin helper for custom subclassing admin.ModelAdmin.
Source code in guardian/admin.py
117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 | |
get_obj_perms_base_context(request, obj)
Get context dict with common admin and object permissions related content.
Returns context dictionary with common admin and object permissions related content. It uses AdminSite.each_context, making sure all required template vars are in the context.
Returns:
| Type | Description |
|---|---|
|
django template context |
Source code in guardian/admin.py
180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 | |
get_obj_perms_group_select_form(request)
Get the form class for group object permissions management. Parameters: request (HttpRequest): The HTTP request object.
Returns:
| Type | Description |
|---|---|
Type[Form]
|
The form class for group object permissions management.
Default is |
Source code in guardian/admin.py
342 343 344 345 346 347 348 349 350 351 | |
get_obj_perms_manage_group_form(request)
Get the form class for group object permissions management.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
HttpRequest
|
The HTTP request object. |
required |
Returns:
| Type | Description |
|---|---|
|
The form class for group object permissions management.
Default is |
Source code in guardian/admin.py
414 415 416 417 418 419 420 421 422 423 424 | |
get_obj_perms_manage_group_template()
Returns object permissions for group admin template.
May be overridden if dynamic behavior is needed.
Returns:
| Type | Description |
|---|---|
|
template name |
Note
If INSTALLED_APPS contains grappelli this function would
return "admin/guardian/grappelli/obj_perms_manage_group.html".
Source code in guardian/admin.py
398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 | |
get_obj_perms_manage_template()
Returns main object permissions admin template. May be overridden if need to change it dynamically.
Note
If INSTALLED_APPS contains grappelli this function would
return "admin/guardian/grappelli/obj_perms_manage.html".
Source code in guardian/admin.py
270 271 272 273 274 275 276 277 278 279 280 281 282 | |
get_obj_perms_manage_user_form(request)
Get the form class for user object permissions management.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
HttpRequest
|
The HTTP request object. |
required |
Returns:
| Type | Description |
|---|---|
Type[Form]
|
The form class for user object permissions management.
Default is |
Source code in guardian/admin.py
353 354 355 356 357 358 359 360 361 362 363 | |
get_obj_perms_manage_user_template()
Returns object permissions for user admin template.
May be overridden if dynamic behavior is needed.
Note
If INSTALLED_APPS contains "grappelli" this function returns
"admin/guardian/grappelli/obj_perms_manage_user.html".
Else, it returns self.obj_perms_manage_user_template.
Source code in guardian/admin.py
316 317 318 319 320 321 322 323 324 325 326 327 328 | |
get_obj_perms_user_select_form(request)
Get the form class for selecting a user for permissions management.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
HttpRequest
|
The HTTP request object. |
required |
Returns:
| Type | Description |
|---|---|
Type[Form]
|
The form class for selecting a user for permissions management.
Default is |
Source code in guardian/admin.py
330 331 332 333 334 335 336 337 338 339 340 | |
get_urls()
Extends standard admin model urls with the following:
- .../permissions/ under app_mdodel_permissions url name (params: object_pk)
- .../permissions/user-manage/<user_id>/ under app_model_permissions_manage_user url name (params: object_pk, user_pk)
- .../permissions/group-manage/<group_id>/ under app_model_permissions_manage_group url name (params: object_pk, group_pk)
Note
... above are standard, instance detail url (i.e. /admin/flatpages/1/)
Source code in guardian/admin.py
145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 | |
obj_perms_manage_group_view(request, object_pk, group_id)
Manages selected groups' permissions for the current object.
Source code in guardian/admin.py
365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 | |
obj_perms_manage_user_view(request, object_pk, user_id)
Manages selected users' permissions for the current object.
Source code in guardian/admin.py
284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 | |
obj_perms_manage_view(request, object_pk)
Main object permissions view.
Presents all users and groups with any object permissions for the current model instance. Users or groups without object permissions for related instance would not be shown. To add or manage user or group, one should use links or forms presented within the page.
Source code in guardian/admin.py
206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 | |