mirror of
https://github.com/fastapi-users/fastapi-users.git
synced 2025-08-16 20:11:20 +08:00
efad0e0fef
* fix: Change on the inheritance model, according to the documentation for the request body parameters. #171 * fix: Changes on the documentation examples to fix the inheritance problem when passing the User class (for create or update only passing the pydantic one) #171 * fix: Changes on the documentation examples to fix the inheritance problem when passing the User class (for create or update only passing the pydantic one) #171 * Put back inheritance on update model and factorize create_update_dict methods Co-authored-by: François Voron <fvoron@gmail.com>
1.6 KiB
1.6 KiB
User model
FastAPI Users defines a minimal User model for authentication purposes. It is structured like this:
id(UUID4) – Unique identifier of the user. Default to a UUID4.email(str) – Email of the user. Validated byemail-validator.is_active(bool) – Whether or not the user is active. If not, login and forgot password requests will be denied. Default toTrue.is_superuser(bool) – Whether or not the user is a superuser. Useful to implement administration logic. Default toFalse.
Define your models
There are four Pydantic models variations provided as mixins:
BaseUser, which provides the basic fields and validation ;BaseCreateUser, dedicated to user registration, which consists of compulsoryemailandpasswordfields ;BaseUpdateUser, dedicated to user profile update, which adds an optionalpasswordfield ;BaseUserDB, which is a representation of the user in database, adding ahashed_passwordfield.
You should define each of those variations, inheriting from each mixin:
from fastapi_users import models
class User(models.BaseUser):
pass
class UserCreate(models.BaseUserCreate):
pass
class UserUpdate(User, models.BaseUserUpdate):
pass
class UserDB(User, models.BaseUserDB):
pass
You can of course add you own properties there to fit to your needs!
Next steps
Depending on your database backend, database configuration will differ a bit.