Permissions

Django OAuth Toolkit provides a few utility classes to use along with other permissions in Django REST Framework, so you can easily add scoped-based permission checks to your API views.

More details on how to add custom permissions to your API Endpoints can be found at the official Django REST Framework documentation

TokenHasScope

The TokenHasScope permission class allows access only when the current access token has been authorized for all the scopes listed in the required_scopes field of the view.

For example:

  1. class SongView(views.APIView):
  2. authentication_classes = [OAuth2Authentication]
  3. permission_classes = [TokenHasScope]
  4. required_scopes = ['music']

The required_scopes attribute is mandatory.

TokenHasReadWriteScope

The TokenHasReadWriteScope permission class allows access based on the READ_SCOPE and WRITE_SCOPE configured in the settings.

When the current request’s method is one of the “safe” methods GET, HEAD, OPTIONS the access is allowed only if the access token has been authorized for the READ_SCOPE scope. When the request’s method is one of POST, PUT, PATCH, DELETE the access is allowed if the access token has been authorized for the WRITE_SCOPE.

The required_scopes attribute is optional and can be used by other scopes needed in the view.

For example:

  1. class SongView(views.APIView):
  2. authentication_classes = [OAuth2Authentication]
  3. permission_classes = [TokenHasReadWriteScope]
  4. required_scopes = ['music']

When a request is performed both the READ_SCOPE \ WRITE_SCOPE and ‘music’ scopes are required to be authorized for the current access token.

TokenHasResourceScope

The TokenHasResourceScope permission class allows access only when the current access token has been authorized for all the scopes listed in the required_scopes field of the view but according of request’s method.

When the current request’s method is one of the “safe” methods, the access is allowed only if the access token has been authorized for the scope:read scope (for example music:read). When the request’s method is one of “non safe” methods, the access is allowed only if the access token has been authorized for the scope:write scope (for example music:write).

  1. class SongView(views.APIView):
  2. authentication_classes = [OAuth2Authentication]
  3. permission_classes = [TokenHasResourceScope]
  4. required_scopes = ['music']

The required_scopes attribute is mandatory (you just need inform the resource scope).

IsAuthenticatedOrTokenHasScope

The IsAuthenticatedOrTokenHasScope permission class allows access only when the current access token has been authorized for all the scopes listed in the required_scopes field of the view but according to the request’s method. It also allows access to Authenticated users who are authenticated in django, but were not authenticated through the OAuth2Authentication class. This allows for protection of the API using scopes, but still let’s users browse the full browseable API. To restrict users to only browse the parts of the browseable API they should be allowed to see, you can combine this with the DjangoModelPermission or the DjangoObjectPermission.

For example:

  1. class SongView(views.APIView):
  2. permission_classes = [IsAuthenticatedOrTokenHasScope, DjangoModelPermission]
  3. required_scopes = ['music']

The required_scopes attribute is mandatory.

TokenMatchesOASRequirements

The TokenMatchesOASRequirements permission class allows the access based on a per-method basis and with alternative lists of required scopes. This permission provides full functionality required by REST API specifications like the OpenAPI Specification (OAS) security requirement object.

The required_alternate_scopes attribute is a required map keyed by HTTP method name where each value is a list of alternative lists of required scopes.

In the follow example GET requires “read” scope, POST requires either “create” scope OR “post” and “widget” scopes, etc.

  1. class SongView(views.APIView):
  2. authentication_classes = [OAuth2Authentication]
  3. permission_classes = [TokenMatchesOASRequirements]
  4. required_alternate_scopes = {
  5. "GET": [["read"]],
  6. "POST": [["create"], ["post", "widget"]],
  7. "PUT": [["update"], ["put", "widget"]],
  8. "DELETE": [["delete"], ["scope2", "scope3"]],
  9. }

The following is a minimal OAS declaration that shows the same required alternate scopes. It is complete enough to try it in the swagger editor.

  1. openapi: "3.0.0"
  2. info:
  3. title: songs
  4. version: v1
  5. components:
  6. securitySchemes:
  7. song_auth:
  8. type: oauth2
  9. flows:
  10. implicit:
  11. authorizationUrl: http://localhost:8000/o/authorize
  12. scopes:
  13. read: read about a song
  14. create: create a new song
  15. update: update an existing song
  16. delete: delete a song
  17. post: create a new song
  18. widget: widget scope
  19. scope2: scope too
  20. scope3: another scope
  21. paths:
  22. /songs:
  23. get:
  24. security:
  25. - song_auth: [read]
  26. responses:
  27. '200':
  28. description: A list of songs.
  29. post:
  30. security:
  31. - song_auth: [create]
  32. - song_auth: [post, widget]
  33. responses:
  34. '201':
  35. description: new song added
  36. put:
  37. security:
  38. - song_auth: [update]
  39. - song_auth: [put, widget]
  40. responses:
  41. '204':
  42. description: song updated
  43. delete:
  44. security:
  45. - song_auth: [delete]
  46. - song_auth: [scope2, scope3]
  47. responses:
  48. '200':
  49. description: song deleted