Overview¶

The schema below shows you how the library is structured and how each part fit together.

flowchart LR FASTAPI_USERS{FastAPIUsers} USER_MANAGER{UserManager} DATABASE_DEPENDENCY[[get_user_db]] USER_MANAGER_DEPENDENCY[[get_user_manager]] CURRENT_USER[[current_user]] subgraph MODELS[Models] direction RL USER[User] USER_CREATE[UserCreate] USER_UPDATE[UserUpdate] USER_DB[UserDB] end subgraph DATABASE[Database adapters] direction RL SQLALCHEMY[SQLAlchemy] MONGODB[MongoDB] TORTOISE[Tortoise ORM] ORMAR[Ormar] end subgraph ROUTERS[Routers] direction RL REGISTER[[get_register_router]] VERIFY[[get_verify_router]] RESET[[get_reset_password_router]] AUTH[[get_auth_router]] OAUTH[[get_oauth_router]] USERS[[get_users_router]] end subgraph AUTH_BACKENDS[Authentication backends] direction RL COOKIE[CookieAuthentication] JWT[JWTAuthentication] end DATABASE --> DATABASE_DEPENDENCY DATABASE_DEPENDENCY --> USER_MANAGER MODELS --> USER_MANAGER MODELS --> FASTAPI_USERS USER_MANAGER --> USER_MANAGER_DEPENDENCY USER_MANAGER_DEPENDENCY --> FASTAPI_USERS FASTAPI_USERS --> ROUTERS AUTH_BACKENDS --> AUTH AUTH_BACKENDS --> FASTAPI_USERS FASTAPI_USERS --> CURRENT_USER

Models¶

Pydantic models representing the data structure of a user. Base classes are provided with the required fields to make authentication work. You should sub-class each of them and add your own fields there.

➡️ Configure the models

Database adapters¶

FastAPI Users is compatible with various databases and ORM. To build the interface between those database tools and the library, we provide database adapters classes that you need to instantiate and configure.

➡️ I'm using SQLAlchemy

➡️ I'm using MongoDB

➡️ I'm using Tortoise ORM

➡️ I'm using ormar

Authentication backends¶

Authentication backends define the way users sessions are managed in your app, like access tokens or cookies.

➡️ Configure the authentication backends

`UserManager`¶

The UserManager object bears most of the logic of FastAPI Users: registration, verification, password reset... We provide a BaseUserManager with this common logic; which you should overload to define how to validate passwords or handle events.

This UserManager object should be provided through a FastAPI dependency, get_user_manager.

➡️ Configure UserManager

`FastAPIUsers` and routers¶

Finally, FastAPIUsers object is the main class from which you'll be able to generate routers for classic routes like registration or login, but also get the current_user dependency factory to inject the authenticated user in your own routes.

➡️ Configure FastAPIUsers and routers