django-tenant-users Documentation

django-tenant-users enhances django-tenants by refining user management in multi-tenancy setups. This application ensures users authenticate globally while having permissions specific to each tenant.

Why use django-tenant-users?

• Global Authentication:

  Users can authenticate once and gain access to multiple tenants. This provides a streamlined login experience, eliminating the need for multiple account setups.

• Tenant-Specific Permissions:

  Even though users can authenticate globally, their permissions are tailored to each specific tenant they interact with. This ensures that a user’s actions are always in line with the specific rules and roles of each tenant, including specific permissions for the public tenant.

• Seamless Integration with Django:

  django-tenant-users is designed to gel seamlessly with Django’s built-in user and permissions frameworks.

Dependencies

While django-tenant-users offers specialized user management for multi-tenancy, it’s built on the solid foundation of django-tenants. If you’re new to django-tenants, check out their official documentation to get the full picture.

Table of Contents

Contents

• Installation
  • Prerequisites
  • Installing django-tenant-users
  • Configuring Your Django Project
  • Provision Public Tenant
  • Fin!
• Using django-tenant-users
  • Provisioning a New Tenant
  • Creating a User
  • Deletion Mechanism
  • Tenant/User Management
  • Utilities and Helper Functions
• Core Concepts
  • TenantBase: Extending Tenant Management
  • The Need for a Custom User Model
  • Custom Authentication Backend: UserBackend
  • Handling User and Tenant “Deletion”
• Models Reference
  • TenantBase Model
  • User Model
  • UserProfile Manager
• Permissions Reference
  • Permission Utilities
  • Permission Models
• Utility Reference
  • Tasks
  • Utilities
• Contributing to Django Tenant Users
  • Code of Conduct
  • Getting Started
  • Making Changes
  • Code Style
  • Documentation
  • Tests
  • Questions and Support