From 4fd6e09fdce02c00dfbde9d45a815e9d93060756 Mon Sep 17 00:00:00 2001 From: Tobias Bengfort Date: Thu, 28 Feb 2019 15:27:15 +0100 Subject: [PATCH] [2.1.x] Clarified permission-related docs. Backport of 632d4861ddb99a2c9d11642fcfa4ad542b427d6b from master --- docs/topics/auth/customizing.txt | 2 +- docs/topics/auth/index.txt | 1 + 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/topics/auth/customizing.txt b/docs/topics/auth/customizing.txt index b5cb3cf6c1..6c78aeb425 100644 --- a/docs/topics/auth/customizing.txt +++ b/docs/topics/auth/customizing.txt @@ -95,7 +95,7 @@ a set of optional permission related :ref:`authorization methods The ``get_user`` method takes a ``user_id`` -- which could be a username, database ID or whatever, but has to be the primary key of your user object -- -and returns a user object. +and returns a user object or ``None``. The ``authenticate`` method takes a ``request`` argument and credentials as keyword arguments. Most of the time, it'll just look like this:: diff --git a/docs/topics/auth/index.txt b/docs/topics/auth/index.txt index 3224af74c7..13d30a9154 100644 --- a/docs/topics/auth/index.txt +++ b/docs/topics/auth/index.txt @@ -44,6 +44,7 @@ of these common problems have been implemented in third-party packages: * Password strength checking * Throttling of login attempts * Authentication against third-parties (OAuth, for example) +* Object-level permissions Installation ============