Welcome to the Hello, ID Please documentation!

“Hello, ID Please” (HIdP) is a Django application that offers a full-featured authentication system for Django projects. It is designed with the OWASP best practices in mind and offers a secure and flexible solution for registering and authenticating users in Django projects.

Requirements

• Python >=3.11

• Django >=4.2,<6

Index

• Installation
  • Install with pip
  • Settings
  • Database migrations
  • Create a superuser
  • Test the installation
  • Templates
  • Translations
• Installation Extras
  • Available Extras
  • Base Installation
• Registration
  • Email and password registration
  • Registration via OpenID Connect
• Configure OIDC Clients
  • Quick Start
  • Obtaining Client Credentials
  • Adding support for other OIDC Providers
• Configure as OIDC Provider
  • Installation
  • Configure Django OAuth Toolkit
  • Database migrations
  • Add Application
  • Provided URLs
  • Django REST Framework recommendations
  • Adding/overriding Django OAuth Toolkit settings
  • Translations
• Content Security Policy
  • Decorator
  • Template tag
• Users
  • Model
  • QuerySet
  • Manager
• Password Validators
  • Available validators
  • Configuring Password Validators
• One-time Passwords (OTP)
  • Installation
  • Configuration
  • Usage
  • Available OTP Policies
  • Examples
  • Customizing OTP Policies
• Templates
  • Base templates
  • Inclusion templates
  • accounts/
  • accounts/management/
  • accounts/management/email/
  • accounts/recovery
  • accounts/recovery/email/
  • accounts/verification
  • accounts/verification/email/
  • federated/
  • otp/
  • otp/email/
• Multi-language support
  • Enabling translations for your project
  • Translating strings
• Management Commands
  • remove_stale_unverified_accounts
  • remove_complete_and_stale_email_change_requests
  • refresh_oidc_clients_jwks
  • cleartokens
• Rate limiting
  • Default rate limits
  • Login page “soft” rate limit
  • Adding your own rate limits
  • Security considerations
• Terms of Service
  • TermsOfServiceMixin
  • Terms of Service Template

Indices and tables

• Index

• Module Index

• Search Page