django-organizations

The invitation and registration backends allow account users to add new users to their accounts and enable user self-registration.

Each base backend class provides a common interface designed to work with your specific user models, registration systems, or other account tools. The default invitation backend accepts an email address and returns a user that either matches that email or creates a new user with that email. The view responsible for adding the user is then tasked with linking that user to the organization.

The project provides default class-based views for managing organizations and memberships. These views are built on a set of mixins that:

• Limit access based on the user's relationship to an organization.
• Automatically query the correct organization or user based on URL keywords.

Developers are encouraged to use these mixins as a foundation for building custom, project-specific functionality.

The library provides three primary models to manage multi-user groups:

• Organization: The central group object. This is the entity you associate with your application's features (e.g., subscriptions, projects, or repositories).
• OrganizationUser: A custom through model for the ManyToMany relationship between Organization and User. It stores user-specific metadata for that organization and facilitates ownership links.
• OrganizationOwner: A model representing the user with authority over the organization's lifecycle. It maintains a one-to-one relationship with an OrganizationUser, allowing a single User to own multiple organizations.

The library is built around three primary models:

1. Organization: The group object (e.g., a company, a project, or a subscription container).
2. Organization User: A through model relating a User to an Organization. It allows storing organization-specific user data and facilitates ownership.
3. Organization Owner: A model linking to an Organization User who has administrative rights over the organization.

Relationship Model:

• An OrganizationUser is associated with exactly one Organization.
• A User can be associated with multiple OrganizationUsers, allowing a single user to belong to multiple Organizations.

Note: Because of this many-to-many relationship, do not use the OrganizationUser class as a UserProfile (which requires a one-to-one relationship). Use a dedicated profile model for user-specific data instead.

When choosing how to implement your organization models, consider the following differences:

You can create relationships between different types of organizations by using inheritance between your custom organization models. This allows one organization type to act as a parent to another.

Example of an Association containing multiple Teams:

from django.db import models
from organizations.models import Organization
from sports.models import Sport

class Association(Organization):
    sport = models.ForeignKey(Sport, related_name="associations")

class Team(Organization):
    association = models.ForeignKey(Association, related_name="teams")
    city = models.CharField(max_length=100)

To use the default organization, organization user, and organization owner models, add organizations to your INSTALLED_APPS in your Django settings file. Ensure you already have a user system (like django.contrib.auth) in place.

INSTALLED_APPS = (
    'django.contrib.auth',
    'organizations',
)