mirror of
https://github.com/fastapi-users/fastapi-users.git
synced 2025-08-16 03:40:23 +08:00
a5618399a1
* Start to write documentation * Add docs favicon * Add routes documentation * Add doc about dependency callables * Add information about how to make authenticated calls
37 lines
1.3 KiB
Markdown
37 lines
1.3 KiB
Markdown
# Dependency callables
|
|
|
|
**FastAPI Users** provides dependency callables to easily inject users in your routes. They are available from your `FastAPIUsers` instance.
|
|
|
|
!!! tip
|
|
For more information about how to make an authenticated request to your API, check the documentation of your [Authentication method](../configuration/authentication/index.md).
|
|
|
|
## `get_current_user`
|
|
|
|
Get the current user (**active or not**). Will throw a `401 Unauthorized` if missing or wrong credentials.
|
|
|
|
```py
|
|
@app.get('/protected-route')
|
|
def protected_route(user: User = Depends(fastapi_users.get_current_user)):
|
|
return f'Hello, {user.email}'
|
|
```
|
|
|
|
## `get_current_active_user`
|
|
|
|
Get the current active user. Will throw a `401 Unauthorized` if missing or wrong credentials or if the user is not active.
|
|
|
|
```py
|
|
@app.get('/protected-route')
|
|
def protected_route(user: User = Depends(fastapi_users.get_current_active_user)):
|
|
return f'Hello, {user.email}'
|
|
```
|
|
|
|
## `get_current_superuser`
|
|
|
|
Get the current superuser. Will throw a `401 Unauthorized` if missing or wrong credentials or if the user is not active. Will throw a `403 Forbidden` if the user is not a superuser.
|
|
|
|
```py
|
|
@app.get('/protected-route')
|
|
def protected_route(user: User = Depends(fastapi_users.get_current_superuser)):
|
|
return f'Hello, {user.email}'
|
|
```
|