mirror of
https://github.com/netbox-community/netbox.git
synced 2026-04-10 11:23:58 +02:00
94612fd728
Meta.permissions is the documented approach for plugins. The register_model_actions function is now an internal implementation detail.
25 lines
1.0 KiB
Markdown
25 lines
1.0 KiB
Markdown
# Custom Model Actions
|
|
|
|
Plugins can register custom permission actions for their models. These actions appear as checkboxes in the ObjectPermission form, making it easy for administrators to grant or restrict access to plugin-specific functionality without manually entering action names.
|
|
|
|
For example, a plugin might define a "sync" action for a model that syncs data from an external source, or a "bypass" action that allows users to bypass certain restrictions.
|
|
|
|
## Registering Model Actions
|
|
|
|
The preferred way to register custom actions is via Django's `Meta.permissions` on the model class. NetBox will automatically register these as model actions when the app is loaded:
|
|
|
|
```python
|
|
from netbox.models import NetBoxModel
|
|
|
|
class MyModel(NetBoxModel):
|
|
# ...
|
|
|
|
class Meta:
|
|
permissions = [
|
|
('sync', 'Synchronize data from external source'),
|
|
('export', 'Export data to external system'),
|
|
]
|
|
```
|
|
|
|
Once registered, these actions appear as checkboxes in a flat list when creating or editing an ObjectPermission.
|