mirror of
https://github.com/fastapi-users/fastapi-users.git
synced 2025-08-15 03:04:27 +08:00

* Use a generic Protocol model for User instead of Pydantic
* Remove UserDB Pydantic schema
* Harmonize schema variable naming to avoid confusions
* Revamp OAuth account model management
* Revamp AccessToken DB strategy to adopt generic model approach
* Make ID a generic instead of forcing UUIDs
* Improve generic typing
* Improve Strategy typing
* Tweak base DB typing
* Don't set Pydantic schemas on FastAPIUsers class: pass it directly on router creation
* Add IntegerIdMixin and export related classes
* Start to revamp doc for V10
* Revamp OAuth documentation
* Fix code highlights
* Write the 9.x.x ➡️ 10.x.x migration doc
* Fix pyproject.toml
953 B
953 B
Auth router
The auth router will generate /login
and /logout
routes for a given authentication backend.
Check the routes usage to learn how to use them.
Setup
import uuid
from fastapi import FastAPI
from fastapi_users import FastAPIUsers
from .db import User
fastapi_users = FastAPIUsers[User, uuid.UUID](
get_user_manager,
[auth_backend],
)
app = FastAPI()
app.include_router(
fastapi_users.get_auth_router(auth_backend),
prefix="/auth/jwt",
tags=["auth"],
)
Optional: user verification
You can require the user to be verified (i.e. is_verified
property set to True
) to allow login. You have to set the requires_verification
parameter to True
on the router instantiation method:
app.include_router(
fastapi_users.get_auth_router(auth_backend, requires_verification=True),
prefix="/auth/jwt",
tags=["auth"],
)