python/fastapi-users
1
0
Fork 0
mirror of https://github.com/fastapi-users/fastapi-users.git synced 2025-08-16 03:40:23 +08:00
Code Issues Packages Projects Releases Wiki Activity
Files
fastapi-users/docs/configuration/model.md
François Voron a5618399a1 Fix #9: Write documentation (#16) 
* Start to write documentation

* Add docs favicon

* Add routes documentation

* Add doc about dependency callables

* Add information about how to make authenticated calls
2019-10-19 18:16:08 +02:00

991 B
Raw Blame History

User model

FastAPI Users defines a minimal User model for authentication purposes. It is structured like this:

  • id (str) – Unique identifier of the user. Default to a UUID4.
  • email (str) – Email of the user. Validated by email-validator.
  • is_active (bool) – Whether or not the user is active. If not, login and forgot password requests will be denied. Default to True.
  • is_active (bool) – Whether or not the user is a superuser. Useful to implement administration logic. Default to False.

Use the model

The model is exposed as a Pydantic model mixin.

from fastapi_users import BaseUser


class User(BaseUser):
    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.

I'm using SQLAlchemy

I'm using MongoDB