From 392f5acc62a356784520ac2a9f40d2c526c967af Mon Sep 17 00:00:00 2001 From: Pritesh K Date: Wed, 10 Jun 2020 13:58:14 +0530 Subject: [PATCH] updated permission docs for IsSuperUser --- docs/api-guide/permissions.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/api-guide/permissions.md b/docs/api-guide/permissions.md index ac2924a83..0d265ef8f 100644 --- a/docs/api-guide/permissions.md +++ b/docs/api-guide/permissions.md @@ -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. +## 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 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`.