Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nnseva/django-rest-access
Django REST Framework permissions backend based on the django-access package
https://github.com/nnseva/django-rest-access
access access-control authority authorization authorization-backend django django-access django-rest django-rest-framework drf dynamic evaluation evaluation-based guard instance-level permissions permissions-backend row-level
Last synced: about 2 months ago
JSON representation
Django REST Framework permissions backend based on the django-access package
- Host: GitHub
- URL: https://github.com/nnseva/django-rest-access
- Owner: nnseva
- License: lgpl-3.0
- Created: 2020-04-20T21:14:44.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2020-04-20T21:57:14.000Z (over 4 years ago)
- Last Synced: 2024-10-13T01:41:08.244Z (3 months ago)
- Topics: access, access-control, authority, authorization, authorization-backend, django, django-access, django-rest, django-rest-framework, drf, dynamic, evaluation, evaluation-based, guard, instance-level, permissions, permissions-backend, row-level
- Language: Python
- Homepage:
- Size: 17.6 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://travis-ci.com/nnseva/django-rest-access)
# Django-REST-Access
The Django-REST-Access package provides a permissions backend for the [Django REST Framework](https://www.django-rest-framework.org)
using access rules defined by the [Django-Access](https://github.com/nnseva/django-access) package.
## Installation
*Stable version* from the PyPi package repository
```bash
pip install django-rest-access
```
*Last development version* from the GitHub source version control system
```bash
pip install git+git://github.com/nnseva/django-rest-access.git
```
## Configuration
Include the `rest_framework`, `access`, and `rest_access` applications into the `INSTALLED_APPS` list, like:
```python
INSTALLED_APPS = [
'django.contrib.admin',
'django.contrib.auth',
...
'rest_framework',
'access',
'rest_access',
...
]
```
## Using
### Define access rules
Define access rules as it is described in the [Django-Access](https://github.com/nnseva/django-access) package documentation.
### Serializer Mixin
Use `rest_access.access.AccessSerializerMixin` as a first of base classes for every Serializer in your API description which
should be controlled by access rules defined using [Django-Access](https://github.com/nnseva/django-access) package, like:
```python
from rest_framework import serializers, viewsets
from rest_access.access import AccessSerializerMixin
from django.contrib.auth.models import User, Group
...
class GroupSerializer(AccessSerializerMixin, serializers.HyperlinkedModelSerializer):
class Meta:
model = Group
fields = ('url', 'id', 'name')
```
### Authorization backend to use
The authorization backend `rest_access.access.AccessPermission` should be used as the both,
permission control backend and filtering class.
The `rest_access.access.AccessPermission` can be used together with other
permission control backends and filtering classes without restrictions.
#### Using authorization backend individually for selected model views
You can assign a permissions control backend and filtering class for the sole, or some subset of model views
or viewsets like it is described in the
[Django REST Framework permission documentation](https://www.django-rest-framework.org/api-guide/permissions/)
and [Django REST Framework filtering documentation](https://www.django-rest-framework.org/api-guide/filtering/)
correspondingly:
```python
from rest_framework import serializers, viewsets
...
class SomeModelViewSet(viewsets.ModelViewSet):
...
permission_classes = ['rest_access.access.AccessPermission']
filter_backends = ['rest_access.access.AccessPermission']
```
#### Using authorization backend as a default one
You can assign a permission control backend and filtering class as default ones for all views in the project using settings module
as it is described in the [Django REST Framework settings documentation](https://www.django-rest-framework.org/api-guide/settings/):
```python
REST_FRAMEWORK = {
'DEFAULT_PERMISSION_CLASSES': [
'rest_access.access.AccessPermission'
],
'DEFAULT_FILTER_BACKENDS': [
'rest_access.access.AccessPermission'
],
}
```