Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

[1.5.x] Refs #14881 -- Document that User models need to have an inte…

…ger primary key.

Thanks to Kaloian Minkov for the reminder about this undocumented requirement.

(cherry picked from commit 91c26ea)
  • Loading branch information...
commit 461d6e22957770449cd99367358c5e419bc3a86d 1 parent 5a803ce
@freakboy3742 freakboy3742 authored
Showing with 4 additions and 2 deletions.
  1. +4 −2 docs/topics/auth/customizing.txt
View
6 docs/topics/auth/customizing.txt
@@ -460,11 +460,13 @@ Specifying a custom User model
Django expects your custom User model to meet some minimum requirements.
-1. Your model must have a single unique field that can be used for
+1. Your model must have an integer primary key.
+
+2. Your model must have a single unique field that can be used for
identification purposes. This can be a username, an email address,
or any other unique attribute.
-2. Your model must provide a way to address the user in a "short" and
+3. Your model must provide a way to address the user in a "short" and
"long" form. The most common interpretation of this would be to use
the user's given name as the "short" identifier, and the user's full
name as the "long" identifier. However, there are no constraints on
Please sign in to comment.
Something went wrong with that request. Please try again.