mirror of
https://github.com/fastapi-users/fastapi-users.git
synced 2025-11-08 08:56:33 +08:00
373157c284
* Add routes for user activation (#403) * Add routes for user activation Generate a token after creating the user in register route, passing to `activation_callback`, if `activation_callback` supplied Create new `/activate` route that will verify the token and activate the user Add new error codes to `fastapi_users/router/common.py` Update documentation Add tests Co-authored-by: Mark Todd <markpeter.todd@hotmail.co.uk> * Rework routes for user activation * Separate verification logic and token generation into `/fastapi_users/router/verify.py`, with per-route callbacks for custom behaviour * Return register router to original state * Added `is_verified` property to user models * Added `requires_verification` argument to `get_users_router`and `get_auth_router` * Additional dependencies added for verification in `fastapi_users/authentication/__init__.py` * Update tests for new behaviour * Update `README.md` to describe a workaround for possible problems during testing, by exceeding ulimit file descriptor limit Co-authored-by: Mark Todd <markpeter.todd@hotmail.co.uk> * Restored docs to original state. * All other modifications reqested added Kebab-case on request-verify-token SECRET now used as test string Other minor changes Co-authored-by: Mark Todd <markpeter.todd@hotmail.co.uk> * Embed token in body in verify route * Reorganize checks in verify route and add unit test * Ignore coverage on Protocol classes * Tweak verify_user function to take full user in parameter * Improve unit tests structure regarding parametrized test client * Make after_verification_request optional to be more consistent with other routers * Tweak status codes on verify routes * Write documentation for verification feature * Add not released warning on verify docs Co-authored-by: Edd Salkield <edd@salkield.uk> Co-authored-by: Mark Todd <markpeter.todd@hotmail.co.uk>
46 lines
1.1 KiB
Markdown
46 lines
1.1 KiB
Markdown
# Auth router
|
|
|
|
The auth router will generate `/login` and `/logout` (if applicable) 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
|
|
from fastapi_users.authentication import JWTAuthentication
|
|
|
|
SECRET = "SECRET"
|
|
|
|
jwt_authentication = JWTAuthentication(secret=SECRET, lifetime_seconds=3600))
|
|
|
|
fastapi_users = FastAPIUsers(
|
|
user_db,
|
|
[jwt_authentication],
|
|
User,
|
|
UserCreate,
|
|
UserUpdate,
|
|
UserDB,
|
|
)
|
|
|
|
app = FastAPI()
|
|
app.include_router(
|
|
fastapi_users.get_auth_router(jwt_authentication),
|
|
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_validation` parameter to `True` on the router instantiation method:
|
|
|
|
```py
|
|
app.include_router(
|
|
fastapi_users.get_auth_router(jwt_authentication, requires_verification=True),
|
|
prefix="/auth/jwt",
|
|
tags=["auth"],
|
|
)
|
|
```
|