Cookies are an easy way to store stateful information into the user browser. Thus, it is more useful for browser-based navigation (e.g. a front-end app making API requests) rather than pure API interaction.
from fastapi_users.authentication import CookieAuthentication +from fastapi_users.authentication import CookieAuthentication SECRET = "SECRET" @@ -636,16 +636,16 @@ cookie_authentication = CookieAuthentication(secret=SECRET, lifetime_seconds=3600)) auth_backends.append(cookie_authentication) - +
from fastapi_users.authentication import CookieAuthentication SECRET = "SECRET" @@ -636,16 +636,16 @@ cookie_authentication = CookieAuthentication(secret=SECRET, lifetime_seconds=3600)) auth_backends.append(cookie_authentication) -
As you can see, instantiation is quite simple. You just have to define a constant SECRET which is used to encode the token and the lifetime of the cookie (in seconds).
SECRET
You can optionally define the name which will be used to generate its /login route. Defaults to cookie.
name
/login
cookie
cookie_authentication = CookieAuthentication( +cookie_authentication = CookieAuthentication( secret=SECRET, lifetime_seconds=3600, name="my-cookie", ) - +
cookie_authentication = CookieAuthentication( secret=SECRET, lifetime_seconds=3600, name="my-cookie", ) -
You can also define the parameters for the generated cookie:
JSON Web Token (JWT) is an internet standard for creating access tokens based on JSON.
from fastapi_users.authentication import JWTAuthentication +from fastapi_users.authentication import JWTAuthentication SECRET = "SECRET" @@ -636,25 +636,25 @@ jwt_authentication = JWTAuthentication(secret=SECRET, lifetime_seconds=3600)) auth_backends.append(jwt_authentication) - +
from fastapi_users.authentication import JWTAuthentication SECRET = "SECRET" @@ -636,25 +636,25 @@ jwt_authentication = JWTAuthentication(secret=SECRET, lifetime_seconds=3600)) auth_backends.append(jwt_authentication) -
As you can see, instantiation is quite simple. You just have to define a constant SECRET which is used to encode the token and the lifetime of token (in seconds).
You can also optionally define the name which will be used to generate its /login route. Defaults to jwt.
jwt
jwt_authentication = JWTAuthentication( +jwt_authentication = JWTAuthentication( secret=SECRET, lifetime_seconds=3600, name="my-jwt", ) - +
jwt_authentication = JWTAuthentication( secret=SECRET, lifetime_seconds=3600, name="my-jwt", ) -
This method will return a JWT token upon successful login:
200 OK
{ +{ "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoiOTIyMWZmYzktNjQwZi00MzcyLTg2ZDMtY2U2NDJjYmE1NjAzIiwiYXVkIjoiZmFzdGFwaS11c2VyczphdXRoIiwiZXhwIjoxNTcxNTA0MTkzfQ.M10bjOe45I5Ncu_uXvOmVV8QxnL-nZfcH96U90JaocI" } - +
{ "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoiOTIyMWZmYzktNjQwZi00MzcyLTg2ZDMtY2U2NDJjYmE1NjAzIiwiYXVkIjoiZmFzdGFwaS11c2VyczphdXRoIiwiZXhwIjoxNTcxNTA0MTkzfQ.M10bjOe45I5Ncu_uXvOmVV8QxnL-nZfcH96U90JaocI" } -
@@ -670,8 +670,8 @@
This method expects that you provide a Bearer authentication with a valid JWT.
Bearer
curl http://localhost:9000/protected-route -H'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoiOTIyMWZmYzktNjQwZi00MzcyLTg2ZDMtY2U2NDJjYmE1NjAzIiwiYXVkIjoiZmFzdGFwaS11c2VyczphdXRoIiwiZXhwIjoxNTcxNTA0MTkzfQ.M10bjOe45I5Ncu_uXvOmVV8QxnL-nZfcH96U90JaocI' -
curl http://localhost:9000/protected-route -H'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoiOTIyMWZmYzktNjQwZi00MzcyLTg2ZDMtY2U2NDJjYmE1NjAzIiwiYXVkIjoiZmFzdGFwaS11c2VyczphdXRoIiwiZXhwIjoxNTcxNTA0MTkzfQ.M10bjOe45I5Ncu_uXvOmVV8QxnL-nZfcH96U90JaocI' +
We will now configure the main FastAPI Users object that will expose the API router.
FastAPI Users provides the necessary tools to work with MongoDB databases thanks to mongodb/motor package for full async support.
Let's create a MongoDB connection and instantiate a collection.
import motor.motor_asyncio +import motor.motor_asyncio from fastapi import FastAPI from fastapi_users import models from fastapi_users.db import MongoDBUserDatabase @@ -632,12 +632,12 @@ user_db = MongoDBUserDatabase(UserDB, collection) - +
import motor.motor_asyncio from fastapi import FastAPI from fastapi_users import models from fastapi_users.db import MongoDBUserDatabase @@ -632,12 +632,12 @@ user_db = MongoDBUserDatabase(UserDB, collection) -
You can choose any name for the database and the collection.
The database adapter of FastAPI Users makes the link between your database configuration and the users logic. Create it like this.
import motor.motor_asyncio +import motor.motor_asyncio from fastapi import FastAPI from fastapi_users import models from fastapi_users.db import MongoDBUserDatabase @@ -669,7 +669,7 @@ user_db = MongoDBUserDatabase(UserDB, collection) - +
import motor.motor_asyncio from fastapi import FastAPI from fastapi_users import models from fastapi_users.db import MongoDBUserDatabase @@ -669,7 +669,7 @@ user_db = MongoDBUserDatabase(UserDB, collection) -
Notice that we pass a reference to your UserDB model.
UserDB
FastAPI Users provides the necessary tools to work with SQL databases thanks to SQLAlchemy Core and encode/databases package for full async support.
Install the database driver that corresponds to your DBMS:
pip install databases[postgresql] -
pip install databases[postgresql] +
pip install databases[mysql] -
pip install databases[mysql] +
pip install databases[sqlite] -
pip install databases[sqlite] +
For the sake of this tutorial from now on, we'll use a simple SQLite databse.
Let's create a metadata object and declare our User table.
metadata
import databases +import databases import sqlalchemy from fastapi import FastAPI from fastapi_users import models @@ -709,12 +709,12 @@ @app.on_event("shutdown") async def shutdown(): await database.disconnect() - +
import databases import sqlalchemy from fastapi import FastAPI from fastapi_users import models @@ -709,12 +709,12 @@ @app.on_event("shutdown") async def shutdown(): await database.disconnect() -
As you can see, FastAPI Users provides a mixin that will include base fields for our User table. You can of course add you own fields there to fit to your needs!
We'll now create an SQLAlchemy enigne and ask it to create all the defined tables.
import databases +import databases import sqlalchemy from fastapi import FastAPI from fastapi_users import models @@ -769,7 +769,7 @@ @app.on_event("shutdown") async def shutdown(): await database.disconnect() - +
import databases import sqlalchemy from fastapi import FastAPI from fastapi_users import models @@ -769,7 +769,7 @@ @app.on_event("shutdown") async def shutdown(): await database.disconnect() -
Tip
import databases +import databases import sqlalchemy from fastapi import FastAPI from fastapi_users import models @@ -832,7 +832,7 @@ @app.on_event("shutdown") async def shutdown(): await database.disconnect() - +
import databases import sqlalchemy from fastapi import FastAPI from fastapi_users import models @@ -832,7 +832,7 @@ @app.on_event("shutdown") async def shutdown(): await database.disconnect() -
Notice that we pass it three things:
FastAPI Users provides the necessary tools to work with Tortoise ORM.
pip install asyncpg -
pip install asyncpg +
pip install aiomysql -
pip install aiomysql +
pip install aiosqlite -
pip install aiosqlite +
Let's declare our User ORM model.
from fastapi import FastAPI +from fastapi import FastAPI from fastapi_users import models from fastapi_users.db import TortoiseBaseUserModel, TortoiseUserDatabase from tortoise.contrib.starlette import register_tortoise @@ -673,12 +673,12 @@ app = FastAPI() register_tortoise(app, modules={"models": ["path_to_your_package"]}) - +
from fastapi import FastAPI from fastapi_users import models from fastapi_users.db import TortoiseBaseUserModel, TortoiseUserDatabase from tortoise.contrib.starlette import register_tortoise @@ -673,12 +673,12 @@ app = FastAPI() register_tortoise(app, modules={"models": ["path_to_your_package"]}) -
As you can see, FastAPI Users provides an abstract model that will include base fields for our User table. You can of course add you own fields there to fit to your needs!
from fastapi import FastAPI +from fastapi import FastAPI from fastapi_users import models from fastapi_users.db import TortoiseBaseUserModel, TortoiseUserDatabase from tortoise.contrib.starlette import register_tortoise @@ -711,13 +711,13 @@ app = FastAPI() register_tortoise(app, modules={"models": ["path_to_your_package"]}) - +
from fastapi import FastAPI from fastapi_users import models from fastapi_users.db import TortoiseBaseUserModel, TortoiseUserDatabase from tortoise.contrib.starlette import register_tortoise @@ -711,13 +711,13 @@ app = FastAPI() register_tortoise(app, modules={"models": ["path_to_your_package"]}) -
For using Tortoise ORM we must register our models and database.
Tortoise ORM supports integration with Starlette/FastAPI out-of-the-box. It will automatically bind startup and shutdown events.
from fastapi import FastAPI +from fastapi import FastAPI from fastapi_users import models from fastapi_users.db import TortoiseBaseUserModel, TortoiseUserDatabase from tortoise.contrib.starlette import register_tortoise @@ -750,7 +750,7 @@ app = FastAPI() register_tortoise(app, modules={"models": ["path_to_your_package"]}) - +
from fastapi import FastAPI from fastapi_users import models from fastapi_users.db import TortoiseBaseUserModel, TortoiseUserDatabase from tortoise.contrib.starlette import register_tortoise @@ -750,7 +750,7 @@ app = FastAPI() register_tortoise(app, modules={"models": ["path_to_your_package"]}) -
We will now configure an authentication method.
import databases +import databases import sqlalchemy from fastapi import FastAPI from fastapi_users import FastAPIUsers, models @@ -646,10 +646,10 @@ @app.on_event("shutdown") async def shutdown(): await database.disconnect() - +
import databases import sqlalchemy from fastapi import FastAPI from fastapi_users import FastAPIUsers, models @@ -646,10 +646,10 @@ @app.on_event("shutdown") async def shutdown(): await database.disconnect() -
import motor.motor_asyncio +import motor.motor_asyncio from fastapi import FastAPI from fastapi_users import FastAPIUsers, models from fastapi_users.authentication import JWTAuthentication @@ -700,10 +700,10 @@ @fastapi_users.on_after_forgot_password() def on_after_forgot_password(user: User, token: str, request: Request): print(f"User {user.id} has forgot their password. Reset token: {token}") - +
import motor.motor_asyncio from fastapi import FastAPI from fastapi_users import FastAPIUsers, models from fastapi_users.authentication import JWTAuthentication @@ -700,10 +700,10 @@ @fastapi_users.on_after_forgot_password() def on_after_forgot_password(user: User, token: str, request: Request): print(f"User {user.id} has forgot their password. Reset token: {token}") -
from fastapi import FastAPI +from fastapi import FastAPI from fastapi_users import FastAPIUsers, models from fastapi_users.authentication import JWTAuthentication from fastapi_users.db import TortoiseBaseUserModel, TortoiseUserDatabase @@ -756,7 +756,7 @@ @fastapi_users.on_after_forgot_password() def on_after_forgot_password(user: User, token: str, request: Request): print(f"User {user.id} has forgot their password. Reset token: {token}") - +
from fastapi import FastAPI from fastapi_users import FastAPIUsers, models from fastapi_users.authentication import JWTAuthentication from fastapi_users.db import TortoiseBaseUserModel, TortoiseUserDatabase @@ -756,7 +756,7 @@ @fastapi_users.on_after_forgot_password() def on_after_forgot_password(user: User, token: str, request: Request): print(f"User {user.id} has forgot their password. Reset token: {token}") -
You're ready to go! Be sure to check the Usage section to understand how yo work with FastAPI Users.
BaseUserDB
hashed_password
You should define each of those variations, inheriting from each mixin:
from fastapi_users import models +from fastapi_users import models class User(models.BaseUser): @@ -614,7 +614,7 @@ class UserDB(User, models.BaseUserDB): pass - +
from fastapi_users import models class User(models.BaseUser): @@ -614,7 +614,7 @@ class UserDB(User, models.BaseUserDB): pass -
You can of course add you own properties there to fit to your needs!
FastAPI Users provides an optional OAuth2 authentication support. It relies on HTTPX OAuth library, which is a pure-async implementation of OAuth2.
You should install the library with the optional dependencies for OAuth:
pip install fastapi-users[sqlalchemy,oauth] -
pip install fastapi-users[sqlalchemy,oauth] +
pip install fastapi-users[mongodb,oauth] -
pip install fastapi-users[mongodb,oauth] +
pip install fastapi-users[tortoise-orm,oauth] -
pip install fastapi-users[tortoise-orm,oauth] +
You first need to get an HTTPX OAuth client instance. Read the documentation for more information.
from httpx_oauth.clients.google import GoogleOAuth2 +from httpx_oauth.clients.google import GoogleOAuth2 google_oauth_client = GoogleOAuth2("CLIENT_ID", "CLIENT_SECRET") - +
from httpx_oauth.clients.google import GoogleOAuth2 google_oauth_client = GoogleOAuth2("CLIENT_ID", "CLIENT_SECRET") -
The user models differ a bit from the standard one as we have to have a way to store the OAuth information (access tokens, account ids...).
from fastapi_users import models +from fastapi_users import models class User(models.BaseUser, models.BaseOAuthAccountMixin): @@ -756,7 +756,7 @@ class UserDB(User, models.BaseUserDB): pass - +
from fastapi_users import models class User(models.BaseUser, models.BaseOAuthAccountMixin): @@ -756,7 +756,7 @@ class UserDB(User, models.BaseUserDB): pass -
Notice that we inherit from the BaseOAuthAccountMixin, which adds a List of BaseOAuthAccount objects. This object is structured like this:
BaseOAuthAccountMixin
List
BaseOAuthAccount
You'll need to define the table for storing the OAuth account model. We provide a base one for this:
from fastapi_users.db.sqlalchemy import SQLAlchemyBaseOAuthAccountTable +from fastapi_users.db.sqlalchemy import SQLAlchemyBaseOAuthAccountTable class OAuthAccount(SQLAlchemyBaseOAuthAccountTable, Base): pass - +
from fastapi_users.db.sqlalchemy import SQLAlchemyBaseOAuthAccountTable class OAuthAccount(SQLAlchemyBaseOAuthAccountTable, Base): pass -
Then, you should declare it on the database adapter:
user_db = SQLAlchemyUserDatabase(UserDB, database, User.__table__, OAuthAccount.__table__) -
user_db = SQLAlchemyUserDatabase(UserDB, database, User.__table__, OAuthAccount.__table__) +
Nothing to do, the basic configuration is enough.
You'll need to define the Tortoise model for storing the OAuth account model. We provide a base one for this:
from fastapi_users.db.tortoise import TortoiseBaseOAuthAccountModel +from fastapi_users.db.tortoise import TortoiseBaseOAuthAccountModel class OAuthAccount(TortoiseBaseOAuthAccountModel): user = fields.ForeignKeyField("models.User", related_name="oauth_accounts") - +
from fastapi_users.db.tortoise import TortoiseBaseOAuthAccountModel class OAuthAccount(TortoiseBaseOAuthAccountModel): user = fields.ForeignKeyField("models.User", related_name="oauth_accounts") -
Warning
Note that you shouls define the foreign key yourself, so that you can point it the user model in your namespace.
user_db = TortoiseUserDatabase(UserDB, User, OAuthAccount) -
user_db = TortoiseUserDatabase(UserDB, User, OAuthAccount) +
Once you have a FastAPIUsers instance, you can make it generate a single OAuth router for the given client.
FastAPIUsers
from fastapi import FastAPI +from fastapi import FastAPI from fastapi_users import FastAPIUsers from httpx_oauth.clients.google import GoogleOAuth2 @@ -816,13 +816,13 @@ google_oauth_router = fastapi_users.get_oauth_router(google_oauth_client, SECRET) app.include_router(google_oauth_router, prefix="/google-oauth", tags=["users"]) - +
from fastapi import FastAPI from fastapi_users import FastAPIUsers from httpx_oauth.clients.google import GoogleOAuth2 @@ -816,13 +816,13 @@ google_oauth_router = fastapi_users.get_oauth_router(google_oauth_client, SECRET) app.include_router(google_oauth_router, prefix="/google-oauth", tags=["users"]) -
import databases +import databases import sqlalchemy from fastapi import FastAPI from fastapi_users import FastAPIUsers, models @@ -913,10 +913,10 @@ @app.on_event("shutdown") async def shutdown(): await database.disconnect() - +
import databases import sqlalchemy from fastapi import FastAPI from fastapi_users import FastAPIUsers, models @@ -913,10 +913,10 @@ @app.on_event("shutdown") async def shutdown(): await database.disconnect() -
import motor.motor_asyncio +import motor.motor_asyncio from fastapi import FastAPI from fastapi_users import FastAPIUsers, models from fastapi_users.authentication import JWTAuthentication @@ -974,10 +974,10 @@ @fastapi_users.on_after_forgot_password() def on_after_forgot_password(user: User, token: str, request: Request): print(f"User {user.id} has forgot their password. Reset token: {token}") - +
import motor.motor_asyncio from fastapi import FastAPI from fastapi_users import FastAPIUsers, models from fastapi_users.authentication import JWTAuthentication @@ -974,10 +974,10 @@ @fastapi_users.on_after_forgot_password() def on_after_forgot_password(user: User, token: str, request: Request): print(f"User {user.id} has forgot their password. Reset token: {token}") -
from fastapi import FastAPI +from fastapi import FastAPI from fastapi_users import FastAPIUsers, models from fastapi_users.authentication import JWTAuthentication from fastapi_users.db import ( @@ -1046,7 +1046,7 @@ @fastapi_users.on_after_forgot_password() def on_after_forgot_password(user: User, token: str, request: Request): print(f"User {user.id} has forgot their password. Reset token: {token}") - +
from fastapi import FastAPI from fastapi_users import FastAPIUsers, models from fastapi_users.authentication import JWTAuthentication from fastapi_users.db import ( @@ -1046,7 +1046,7 @@ @fastapi_users.on_after_forgot_password() def on_after_forgot_password(user: User, token: str, request: Request): print(f"User {user.id} has forgot their password. Reset token: {token}") -
reset_password_token_secret
reset_password_token_lifetime_seconds
from fastapi_users import FastAPIUsers +from fastapi_users import FastAPIUsers fastapi_users = FastAPIUsers( user_db, @@ -673,12 +673,12 @@ UserDB, SECRET, ) - +
from fastapi_users import FastAPIUsers fastapi_users = FastAPIUsers( user_db, @@ -673,12 +673,12 @@ UserDB, SECRET, ) -
And then, include the router in the FastAPI app:
app = FastAPI() +app = FastAPI() app.include_router(fastapi_users.router, prefix="/users", tags=["users"]) - +
app = FastAPI() app.include_router(fastapi_users.router, prefix="/users", tags=["users"]) -
In order to be as unopinionated as possible, we expose decorators that allow you to plug your own logic after some actions. You can have several handlers per event.
Typically, you'll want to send a welcome e-mail or add it to your marketing analytics pipeline.
You can define it as an async or standard method.
async
Example:
@fastapi_users.on_after_register() +@fastapi_users.on_after_register() def on_after_register(user: User, request: Request): print(f"User {user.id} has registered.") - +
@fastapi_users.on_after_register() def on_after_register(user: User, request: Request): print(f"User {user.id} has registered.") -
This event handler is called after a successful forgot password request. It is called with three arguments:
Typically, you'll want to send an e-mail with the link (and the token) that allows the user to reset their password.
@fastapi_users.on_after_forgot_password() +@fastapi_users.on_after_forgot_password() def on_after_forgot_password(user: User, token: str, request: Request): print(f"User {user.id} has forgot their password. Reset token: {token}") - +
@fastapi_users.on_after_forgot_password() def on_after_forgot_password(user: User, token: str, request: Request): print(f"User {user.id} has forgot their password. Reset token: {token}") -
This event handler is called after a successful update user request. It is called with three arguments:
It may be useful if you wish for example update your user in a data analytics or customer success platform.
@fastapi_users.on_after_update() +@fastapi_users.on_after_update() def on_after_update(user: User, updated_user_data: Dict[str, Any], request: Request): print(f"User {user.id} has been updated with the following data: {updated_user_data}") - +
@fastapi_users.on_after_update() def on_after_update(user: User, updated_user_data: Dict[str, Any], request: Request): print(f"User {user.id} has been updated with the following data: {updated_user_data}") -
Check out a full example that will show you the big picture.
You should have Pipenv installed. Then, you can install the dependencies with:
pipenv install --dev -
pipenv install --dev +
After that, activate the virtual environment:
pipenv shell -
pipenv shell +
You can run all the tests with:
make test -
make test +
The command will start a MongoDB container for the related unit tests. So you should have Docker installed.
Alternatively, you can run pytest yourself. The MongoDB unit tests will be skipped if no server is available on your local machine:
pytest
pytest -
pytest +
Execute the following command to apply isort and black formatting:
isort
black
make format -
make format +
This project is licensed under the terms of the MIT license.
You can add FastAPI Users to your FastAPI project in a few easy steps. First of all, install the dependency:
pip install fastapi-users[sqlalchemy] -
pip install fastapi-users[sqlalchemy] +
pip install fastapi-users[mongodb] -
pip install fastapi-users[mongodb] +
pip install fastapi-users[tortoise-orm] -
pip install fastapi-users[tortoise-orm] +
That's it! Now, let's have a look at our User model.
get_current_user
Get the current user (active or not). Will throw a 401 Unauthorized if missing or wrong credentials.
401 Unauthorized
@app.get('/protected-route') +@app.get('/protected-route') def protected_route(user: User = Depends(fastapi_users.get_current_user)): return f'Hello, {user.email}' - +
@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.
@app.get('/protected-route') +@app.get('/protected-route') def protected_route(user: User = Depends(fastapi_users.get_current_active_user)): return f'Hello, {user.email}' - +
@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.
403 Forbidden
@app.get('/protected-route') +@app.get('/protected-route') def protected_route(user: User = Depends(fastapi_users.get_current_superuser)): return f'Hello, {user.email}' - +
@app.get('/protected-route') def protected_route(user: User = Depends(fastapi_users.get_current_superuser)): return f'Hello, {user.email}' -
If you don't need a user, you can use more clear way:
@app.get('/protected-route', dependencies=[Depends(fastapi_users.get_current_superuser)]) +@app.get('/protected-route', dependencies=[Depends(fastapi_users.get_current_superuser)]) def protected_route(): return 'Hello, some user.' - +
@app.get('/protected-route', dependencies=[Depends(fastapi_users.get_current_superuser)]) def protected_route(): return 'Hello, some user.' -
You can see more about it in FastAPI docs.
Register a new user. Will call the on_after_register event handlers on successful registration.
on_after_register
Payload
{ +{ "email": "king.arthur@camelot.bt", "password": "guinevere" } - +
{ "email": "king.arthur@camelot.bt", "password": "guinevere" } -
201 Created
{ +{ "id": "57cbb51a-ab71-4009-8802-3f54b4f2e23", "email": "king.arthur@camelot.bt", "is_active": true, "is_superuser": false } - +
{ "id": "57cbb51a-ab71-4009-8802-3f54b4f2e23", "email": "king.arthur@camelot.bt", "is_active": true, "is_superuser": false } -
400 Bad Request
A user already exists with this email.
{ +{ "detail": "REGISTER_USER_ALREADY_EXISTS" } - +
{ "detail": "REGISTER_USER_ALREADY_EXISTS" } -
POST /login/{name}
Login a user against the method named name. Check the corresponding authentication method to view the success response.
Payload (application/x-www-form-urlencoded)
application/x-www-form-urlencoded
username=king.arthur@camelot.bt&password=guinevere -
username=king.arthur@camelot.bt&password=guinevere +
Bad credentials or the user is inactive.
{ +{ "detail": "LOGIN_BAD_CREDENTIALS" } - +
{ "detail": "LOGIN_BAD_CREDENTIALS" } -
POST /logout/{name}
To prevent malicious users from guessing existing users in your databse, the route will always return a 202 Accepted response, even if the user requested does not exist.
202 Accepted
{ +{ "email": "king.arthur@camelot.bt" } - +
{ "email": "king.arthur@camelot.bt" } -
Reset a password. Requires the token generated by the /forgot-password route.
/forgot-password
{ +{ "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoiOTIyMWZmYzktNjQwZi00MzcyLTg2ZDMtY2U2NDJjYmE1NjAzIiwiYXVkIjoiZmFzdGFwaS11c2VyczphdXRoIiwiZXhwIjoxNTcxNTA0MTkzfQ.M10bjOe45I5Ncu_uXvOmVV8QxnL-nZfcH96U90JaocI", "password": "merlin" } - +
{ "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoiOTIyMWZmYzktNjQwZi00MzcyLTg2ZDMtY2U2NDJjYmE1NjAzIiwiYXVkIjoiZmFzdGFwaS11c2VyczphdXRoIiwiZXhwIjoxNTcxNTA0MTkzfQ.M10bjOe45I5Ncu_uXvOmVV8QxnL-nZfcH96U90JaocI", "password": "merlin" } -
Bad or expired token.
{ +{ "detail": "RESET_PASSWORD_BAD_TOKEN" } - +
{ "detail": "RESET_PASSWORD_BAD_TOKEN" } -
{ +{ "authorization_url": "https://www.tintagel.bt/oauth/authorize?client_id=CLIENT_ID&scopes=a+b&redirect_uri=https://www.camelot.bt/oauth/callback" } - +
{ "authorization_url": "https://www.tintagel.bt/oauth/authorize?client_id=CLIENT_ID&scopes=a+b&redirect_uri=https://www.camelot.bt/oauth/callback" } -
Return the current authenticated active user.
Update the current authenticated active user.
{ +{ "email": "king.arthur@tintagel.bt", "password": "merlin" } - +
{ "email": "king.arthur@tintagel.bt", "password": "merlin" } -
{ +{ "id": "57cbb51a-ab71-4009-8802-3f54b4f2e23", "email": "king.arthur@tintagel.bt", "is_active": true, "is_superuser": false } - +
{ "id": "57cbb51a-ab71-4009-8802-3f54b4f2e23", "email": "king.arthur@tintagel.bt", "is_active": true, "is_superuser": false } -
Return the list of registered users.
[{ +[{ "id": "57cbb51a-ab71-4009-8802-3f54b4f2e23", "email": "king.arthur@camelot.bt", "is_active": true, "is_superuser": false }] - +
[{ "id": "57cbb51a-ab71-4009-8802-3f54b4f2e23", "email": "king.arthur@camelot.bt", "is_active": true, "is_superuser": false }] -
Return the user with id user_id.
user_id
Update the user with id user_id.
{ +{ "email": "king.arthur@tintagel.bt", "password": "merlin", "is_active": false, "is_superuser": true } - +
{ "email": "king.arthur@tintagel.bt", "password": "merlin", "is_active": false, "is_superuser": true } -
{ +{ "id": "57cbb51a-ab71-4009-8802-3f54b4f2e23", "email": "king.arthur@camelot.bt", "is_active": false, "is_superuser": true } - +
{ "id": "57cbb51a-ab71-4009-8802-3f54b4f2e23", "email": "king.arthur@camelot.bt", "is_active": false, "is_superuser": true } -