Welcome to djoser’s documentation!

Note

djoser 2.x is not backward compatible with djoser 1.x

Basics

• Introduction
• Getting started
  • Available endpoints
  • Supported authentication backends
  • Supported Python / Django / DRF versions
  • Installation
  • Configuration
• Sample usage
• Authentication Backends
  • Token Based Authentication
  • JSON Web Token Authentication

Settings & API

• Settings
  • USER_ID_FIELD
  • LOGIN_FIELD
  • PASSWORD_RESET_CONFIRM_URL
  • USERNAME_RESET_CONFIRM_URL
  • EMAIL_FRONTEND_PROTOCOL
  • EMAIL_FRONTEND_DOMAIN
  • EMAIL_FRONTEND_SITE_NAME
  • SEND_ACTIVATION_EMAIL
  • SEND_CONFIRMATION_EMAIL
  • PASSWORD_CHANGED_EMAIL_CONFIRMATION
  • USERNAME_CHANGED_EMAIL_CONFIRMATION
  • ACTIVATION_URL
  • USER_CREATE_PASSWORD_RETYPE
  • SET_USERNAME_RETYPE
  • SET_PASSWORD_RETYPE
  • PASSWORD_RESET_CONFIRM_RETYPE
  • USERNAME_RESET_CONFIRM_RETYPE
  • LOGOUT_ON_PASSWORD_CHANGE
  • PASSWORD_RESET_SHOW_EMAIL_NOT_FOUND
  • USERNAME_RESET_SHOW_EMAIL_NOT_FOUND
  • TOKEN_MODEL
  • SERIALIZERS
  • EMAIL
  • CONSTANTS
  • SOCIAL_AUTH_TOKEN_STRATEGY
  • SOCIAL_AUTH_ALLOWED_REDIRECT_URIS
  • PERMISSIONS
  • HIDE_USERS
• Base Endpoints
  • User Create
  • User Activate
  • User Resend Activation E-mail
  • User
  • User Delete
  • Set Username
  • Reset Username
  • Reset Username Confirmation
  • Set Password
  • Reset Password
  • Reset Password Confirmation
• Token Endpoints
  • Token Create
  • Token Destroy
• JWT Endpoints
  • JWT Create
  • JWT Refresh
  • JWT Verify
• Social Endpoints
  • Provider Auth
• Signals
  • user_registered
  • user_activated
  • user_updated
• WebAuthn
  • Configuration
  • Endpoints
  • Example app

Usage

• Migration Guide

Indices and tables

• Index

• Search Page