encode/django-rest-framework
1
1
Fork 0
mirror of https://github.com/encode/django-rest-framework.git synced 2025-07-28 00:49:49 +03:00
Code Issues Packages Projects Releases Wiki Activity

updated permission docs for IsSuperUser

Browse Source
This commit is contained in:
Pritesh K 2020-06-10 13:58:14 +05:30
parent 7f2b8815b2
commit 392f5acc62
1 changed files with 6 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/api-guide/permissions.md
View File

@ -161,6 +161,12 @@ The `IsAdminUser` permission class will deny permission to any user, unless `use
This permission is suitable if you want your API to only be accessible to a subset of trusted administrators. This permission is suitable if you want your API to only be accessible to a subset of trusted administrators.
## IsSuperUser
The `IsSuperUser` permission class will deny permission to any user, unless `user.is_superuser` is `True` in which case permission will be allowed.
This permission is suitable if you want your API to only be accessible to only a super user.
## IsAuthenticatedOrReadOnly ## IsAuthenticatedOrReadOnly
The `IsAuthenticatedOrReadOnly` will allow authenticated users to perform any request. Requests for unauthorised users will only be permitted if the request method is one of the "safe" methods; `GET`, `HEAD` or `OPTIONS`. The `IsAuthenticatedOrReadOnly` will allow authenticated users to perform any request. Requests for unauthorised users will only be permitted if the request method is one of the "safe" methods; `GET`, `HEAD` or `OPTIONS`.