mirror of
https://github.com/fastapi-users/fastapi-users.git
synced 2025-08-16 11:53:40 +08:00
c4de66b81c
* Implement Transport classes * Implement authentication strategy classes * Revamp authentication with Transport and Strategy * Revamp strategy and OAuth so that they can use a callable dependency * Update docstring * Make ErrorCode a proper Enum and cleanup unused OpenAPI utils * Remove useless check * Tweak typing in authenticator * Update docs * Improve logout/destroy token logic * Update docs * Update docs * Update docs and full examples * Apply formatting to examples * Update OAuth doc and examples * Add migration doc * Implement Redis session token * Add Redis Session documentation * RedisSession -> Redis * Fix links in docs
41 lines
955 B
Markdown
41 lines
955 B
Markdown
# Auth router
|
|
|
|
The auth router will generate `/login` and `/logout` routes for a given [authentication backend](../authentication/index.md).
|
|
|
|
Check the [routes usage](../../usage/routes.md) to learn how to use them.
|
|
|
|
## Setup
|
|
|
|
```py
|
|
from fastapi import FastAPI
|
|
from fastapi_users import FastAPIUsers
|
|
|
|
fastapi_users = FastAPIUsers(
|
|
get_user_manager,
|
|
[auth_backend],
|
|
User,
|
|
UserCreate,
|
|
UserUpdate,
|
|
UserDB,
|
|
)
|
|
|
|
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:
|
|
|
|
```py
|
|
app.include_router(
|
|
fastapi_users.get_auth_router(auth_backend, requires_verification=True),
|
|
prefix="/auth/jwt",
|
|
tags=["auth"],
|
|
)
|
|
```
|