Ready-to-use and customizable users management for FastAPI
> [!NOTE]
> **This project is now in maintenance mode.** While we'll continue to provide security updates and dependency maintenance, no new features will be added. We encourage you to explore the project and use it as-is, knowing it will remain stable and secure.
>
> We're currently working on a new Python authentication toolkit that will ultimately supersede FastAPI Users. Stay tuned for updates!
[](https://github.com/fastapi-users/fastapi-users/actions)
[](https://codecov.io/gh/fastapi-users/fastapi-users)
[](https://badge.fury.io/py/fastapi-users)
[](https://pepy.tech/project/fastapi-users)
[](#contributors-)
---
**Documentation**: https://fastapi-users.github.io/fastapi-users/
**Source Code**: https://github.com/fastapi-users/fastapi-users
---
Add quickly a registration and authentication system to your [FastAPI](https://fastapi.tiangolo.com/) project. **FastAPI Users** is designed to be as customizable and adaptable as possible.
## Features
- [x] Extensible base user model
- [x] Ready-to-use register, login, reset password and verify e-mail routes
- [x] Ready-to-use social OAuth2 login flow
- [x] Dependency callables to inject current user in route
- [x] Pluggable password validation
- [x] Customizable database backend
- [x] [SQLAlchemy ORM async](https://docs.sqlalchemy.org/en/14/orm/extensions/asyncio.html) included
- [x] [MongoDB with Beanie ODM](https://github.com/roman-right/beanie/) included
- [x] Multiple customizable authentication backends
- [x] Transports: Authorization header, Cookie
- [x] Strategies: JWT, Database, Redis
- [x] Full OpenAPI schema support, even with several authentication backends
## In a hurry? Discover Fief, the open-source authentication platform
**Implementing registration, login, social auth is hard and painful. We know it. With our highly secure and open-source users management platform, you can focus on your app while staying in control of your users data.**
- **Open-source**: self-host it for free
- **Pre-built login and registration pages**: clean and fast authentication so you don't have to do it yourself
- **Official Python client** with built-in **FastAPI integration**
It's free and open-source
## Contributors and sponsors ✨☕️
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
## Development
### Setup environment
We use [Hatch](https://hatch.pypa.io/latest/install/) to manage the development environment and production build. Ensure it's installed on your system.
### Run unit tests
You can run all the tests with:
```bash
hatch run test:test
```
### Format the code
Execute the following command to apply linting and check typing:
```bash
hatch run lint
```
### Serve the documentation
You can serve the documentation locally with the following command:
```bash
hatch run docs
```
The documentation will be available on [http://localhost:8000](http://localhost:8000).
## License
This project is licensed under the terms of the MIT license.
**Implementing registration, login, social auth is hard and painful. We know it. With our highly secure and open-source users management platform, you can focus on your app while staying in control of your users data.**
- **Open-source**: self-host it for free
- **Pre-built login and registration pages**: clean and fast authentication so you don't have to do it yourself
- **Official Python client** with built-in **FastAPI integration**
