mirror of
https://github.com/fastapi-users/fastapi-users.git
synced 2026-03-13 07:49:55 +08:00
1339 lines
42 KiB
HTML
1339 lines
42 KiB
HTML
|
|
<!doctype html>
|
|
<html lang="en" class="no-js">
|
|
<head>
|
|
|
|
<meta charset="utf-8">
|
|
<meta name="viewport" content="width=device-width,initial-scale=1">
|
|
|
|
<meta name="description" content="Ready-to-use and customizable users management for FastAPI">
|
|
|
|
|
|
|
|
|
|
<link rel="shortcut icon" href="../../favicon.png">
|
|
<meta name="generator" content="mkdocs-1.1.2, mkdocs-material-6.1.6">
|
|
|
|
|
|
|
|
<title>Routes - FastAPI Users</title>
|
|
|
|
|
|
|
|
<link rel="stylesheet" href="../../assets/stylesheets/main.6910b76c.min.css">
|
|
|
|
|
|
<link rel="stylesheet" href="../../assets/stylesheets/palette.196e0c26.min.css">
|
|
|
|
|
|
|
|
<meta name="theme-color" content="#ef5552">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<link href="https://fonts.gstatic.com" rel="preconnect" crossorigin>
|
|
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,400,400i,700%7CRoboto+Mono&display=fallback">
|
|
<style>body,input{font-family:"Roboto",-apple-system,BlinkMacSystemFont,Helvetica,Arial,sans-serif}code,kbd,pre{font-family:"Roboto Mono",SFMono-Regular,Consolas,Menlo,monospace}</style>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</head>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<body dir="ltr" data-md-color-scheme="" data-md-color-primary="red" data-md-color-accent="red">
|
|
|
|
|
|
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
|
|
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
|
|
<label class="md-overlay" for="__drawer"></label>
|
|
<div data-md-component="skip">
|
|
|
|
|
|
<a href="#routes" class="md-skip">
|
|
Skip to content
|
|
</a>
|
|
|
|
</div>
|
|
<div data-md-component="announce">
|
|
|
|
</div>
|
|
|
|
|
|
|
|
<header class="md-header" data-md-component="header">
|
|
<nav class="md-header-nav md-grid" aria-label="Header">
|
|
<a href="../.." title="FastAPI Users" class="md-header-nav__button md-logo" aria-label="FastAPI Users">
|
|
|
|
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M16.5 12A2.5 2.5 0 0019 9.5 2.5 2.5 0 0016.5 7 2.5 2.5 0 0014 9.5a2.5 2.5 0 002.5 2.5M9 11a3 3 0 003-3 3 3 0 00-3-3 3 3 0 00-3 3 3 3 0 003 3m7.5 3c-1.83 0-5.5.92-5.5 2.75V19h11v-2.25c0-1.83-3.67-2.75-5.5-2.75M9 13c-2.33 0-7 1.17-7 3.5V19h7v-2.25c0-.85.33-2.34 2.37-3.47C10.5 13.1 9.66 13 9 13z"/></svg>
|
|
|
|
</a>
|
|
<label class="md-header-nav__button md-icon" for="__drawer">
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2z"/></svg>
|
|
</label>
|
|
<div class="md-header-nav__title" data-md-component="header-title">
|
|
|
|
<div class="md-header-nav__ellipsis">
|
|
<span class="md-header-nav__topic md-ellipsis">
|
|
FastAPI Users
|
|
</span>
|
|
<span class="md-header-nav__topic md-ellipsis">
|
|
|
|
Routes
|
|
|
|
</span>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<label class="md-header-nav__button md-icon" for="__search">
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0116 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 019.5 16 6.5 6.5 0 013 9.5 6.5 6.5 0 019.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg>
|
|
</label>
|
|
|
|
<div class="md-search" data-md-component="search" role="dialog">
|
|
<label class="md-search__overlay" for="__search"></label>
|
|
<div class="md-search__inner" role="search">
|
|
<form class="md-search__form" name="search">
|
|
<input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" data-md-state="active" required>
|
|
<label class="md-search__icon md-icon" for="__search">
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0116 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 019.5 16 6.5 6.5 0 013 9.5 6.5 6.5 0 019.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg>
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12z"/></svg>
|
|
</label>
|
|
<button type="reset" class="md-search__icon md-icon" aria-label="Clear" data-md-component="search-reset" tabindex="-1">
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41L17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41z"/></svg>
|
|
</button>
|
|
</form>
|
|
<div class="md-search__output">
|
|
<div class="md-search__scrollwrap" data-md-scrollfix>
|
|
<div class="md-search-result" data-md-component="search-result">
|
|
<div class="md-search-result__meta">
|
|
Initializing search
|
|
</div>
|
|
<ol class="md-search-result__list"></ol>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<div class="md-header-nav__source">
|
|
|
|
<a href="https://github.com/frankie567/fastapi-users" title="Go to repository" class="md-source">
|
|
<div class="md-source__icon md-icon">
|
|
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><path d="M439.55 236.05L244 40.45a28.87 28.87 0 00-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 01-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 000 40.81l195.61 195.6a28.86 28.86 0 0040.8 0l194.69-194.69a28.86 28.86 0 000-40.81z"/></svg>
|
|
</div>
|
|
<div class="md-source__repository">
|
|
frankie567/fastapi-users
|
|
</div>
|
|
</a>
|
|
</div>
|
|
|
|
</nav>
|
|
</header>
|
|
|
|
<div class="md-container" data-md-component="container">
|
|
|
|
|
|
|
|
|
|
<main class="md-main" data-md-component="main">
|
|
<div class="md-main__inner md-grid">
|
|
|
|
|
|
<div class="md-sidebar md-sidebar--primary" data-md-component="navigation">
|
|
<div class="md-sidebar__scrollwrap">
|
|
<div class="md-sidebar__inner">
|
|
|
|
|
|
<nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
|
|
<label class="md-nav__title" for="__drawer">
|
|
<a href="../.." title="FastAPI Users" class="md-nav__button md-logo" aria-label="FastAPI Users">
|
|
|
|
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M16.5 12A2.5 2.5 0 0019 9.5 2.5 2.5 0 0016.5 7 2.5 2.5 0 0014 9.5a2.5 2.5 0 002.5 2.5M9 11a3 3 0 003-3 3 3 0 00-3-3 3 3 0 00-3 3 3 3 0 003 3m7.5 3c-1.83 0-5.5.92-5.5 2.75V19h11v-2.25c0-1.83-3.67-2.75-5.5-2.75M9 13c-2.33 0-7 1.17-7 3.5V19h7v-2.25c0-.85.33-2.34 2.37-3.47C10.5 13.1 9.66 13 9 13z"/></svg>
|
|
|
|
</a>
|
|
FastAPI Users
|
|
</label>
|
|
|
|
<div class="md-nav__source">
|
|
|
|
<a href="https://github.com/frankie567/fastapi-users" title="Go to repository" class="md-source">
|
|
<div class="md-source__icon md-icon">
|
|
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><path d="M439.55 236.05L244 40.45a28.87 28.87 0 00-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 01-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 000 40.81l195.61 195.6a28.86 28.86 0 0040.8 0l194.69-194.69a28.86 28.86 0 000-40.81z"/></svg>
|
|
</div>
|
|
<div class="md-source__repository">
|
|
frankie567/fastapi-users
|
|
</div>
|
|
</a>
|
|
</div>
|
|
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../.." class="md-nav__link">
|
|
About
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../installation/" class="md-nav__link">
|
|
Installation
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--nested">
|
|
|
|
<input class="md-nav__toggle md-toggle" data-md-toggle="nav-3" type="checkbox" id="nav-3" >
|
|
<label class="md-nav__link" for="nav-3">
|
|
Configuration
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
<nav class="md-nav" aria-label="Configuration" data-md-level="1">
|
|
<label class="md-nav__title" for="nav-3">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
Configuration
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../configuration/model/" class="md-nav__link">
|
|
User model
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--nested">
|
|
|
|
<input class="md-nav__toggle md-toggle" data-md-toggle="nav-3-2" type="checkbox" id="nav-3-2" >
|
|
<label class="md-nav__link" for="nav-3-2">
|
|
Databases
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
<nav class="md-nav" aria-label="Databases" data-md-level="2">
|
|
<label class="md-nav__title" for="nav-3-2">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
Databases
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../configuration/databases/sqlalchemy/" class="md-nav__link">
|
|
SQLAlchemy
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../configuration/databases/mongodb/" class="md-nav__link">
|
|
MongoDB
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../configuration/databases/tortoise/" class="md-nav__link">
|
|
Tortoise ORM
|
|
</a>
|
|
</li>
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--nested">
|
|
|
|
<input class="md-nav__toggle md-toggle" data-md-toggle="nav-3-3" type="checkbox" id="nav-3-3" >
|
|
<label class="md-nav__link" for="nav-3-3">
|
|
Authentication
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
<nav class="md-nav" aria-label="Authentication" data-md-level="2">
|
|
<label class="md-nav__title" for="nav-3-3">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
Authentication
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../configuration/authentication/" class="md-nav__link">
|
|
Introduction
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../configuration/authentication/jwt/" class="md-nav__link">
|
|
JWT
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../configuration/authentication/cookie/" class="md-nav__link">
|
|
Cookie
|
|
</a>
|
|
</li>
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--nested">
|
|
|
|
<input class="md-nav__toggle md-toggle" data-md-toggle="nav-3-4" type="checkbox" id="nav-3-4" >
|
|
<label class="md-nav__link" for="nav-3-4">
|
|
Routers
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
<nav class="md-nav" aria-label="Routers" data-md-level="2">
|
|
<label class="md-nav__title" for="nav-3-4">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
Routers
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../configuration/routers/" class="md-nav__link">
|
|
Introduction
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../configuration/routers/auth/" class="md-nav__link">
|
|
Auth router
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../configuration/routers/register/" class="md-nav__link">
|
|
Register routes
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../configuration/routers/reset/" class="md-nav__link">
|
|
Reset password router
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../configuration/routers/users/" class="md-nav__link">
|
|
Users router
|
|
</a>
|
|
</li>
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../configuration/full_example/" class="md-nav__link">
|
|
Full example
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../configuration/oauth/" class="md-nav__link">
|
|
OAuth2
|
|
</a>
|
|
</li>
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--active md-nav__item--nested">
|
|
|
|
<input class="md-nav__toggle md-toggle" data-md-toggle="nav-4" type="checkbox" id="nav-4" checked>
|
|
<label class="md-nav__link" for="nav-4">
|
|
Usage
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
<nav class="md-nav" aria-label="Usage" data-md-level="1">
|
|
<label class="md-nav__title" for="nav-4">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
Usage
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../flow/" class="md-nav__link">
|
|
Flow
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--active">
|
|
|
|
<input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
|
|
|
|
|
|
|
|
|
|
<label class="md-nav__link md-nav__link--active" for="__toc">
|
|
Routes
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
|
|
<a href="./" class="md-nav__link md-nav__link--active">
|
|
Routes
|
|
</a>
|
|
|
|
|
|
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
|
|
|
|
|
|
|
|
|
|
|
|
<label class="md-nav__title" for="__toc">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
Table of contents
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#auth-router" class="md-nav__link">
|
|
Auth router
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="Auth router">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#post-login" class="md-nav__link">
|
|
POST /login
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#post-logout" class="md-nav__link">
|
|
POST /logout
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#register-router" class="md-nav__link">
|
|
Register router
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="Register router">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#post-register" class="md-nav__link">
|
|
POST /register
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#reset-password-router" class="md-nav__link">
|
|
Reset password router
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="Reset password router">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#post-forgot-password" class="md-nav__link">
|
|
POST /forgot-password
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#post-reset-password" class="md-nav__link">
|
|
POST /reset-password
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#oauth-router" class="md-nav__link">
|
|
OAuth router
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="OAuth router">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#get-authorize" class="md-nav__link">
|
|
GET /authorize
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#get-callback" class="md-nav__link">
|
|
GET /callback
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#users-router" class="md-nav__link">
|
|
Users router
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="Users router">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#get-me" class="md-nav__link">
|
|
GET /me
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#patch-me" class="md-nav__link">
|
|
PATCH /me
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#get-user_id" class="md-nav__link">
|
|
GET /{user_id}
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#patch-user_id" class="md-nav__link">
|
|
PATCH /{user_id}
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#delete-user_id" class="md-nav__link">
|
|
DELETE /{user_id}
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../dependency-callables/" class="md-nav__link">
|
|
Dependency callables
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../helpers/" class="md-nav__link">
|
|
Helpers
|
|
</a>
|
|
</li>
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--nested">
|
|
|
|
<input class="md-nav__toggle md-toggle" data-md-toggle="nav-5" type="checkbox" id="nav-5" >
|
|
<label class="md-nav__link" for="nav-5">
|
|
Migration
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
<nav class="md-nav" aria-label="Migration" data-md-level="1">
|
|
<label class="md-nav__title" for="nav-5">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
Migration
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../migration/08_to_1x/" class="md-nav__link">
|
|
0.8.x ➡️ 1.x.x
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../migration/1x_to_2x/" class="md-nav__link">
|
|
1.x.x ➡️ 2.x.x
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../migration/2x_to_3x/" class="md-nav__link">
|
|
2.x.x ➡️ 3.x.x
|
|
</a>
|
|
</li>
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
</li>
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<div class="md-sidebar md-sidebar--secondary" data-md-component="toc">
|
|
<div class="md-sidebar__scrollwrap">
|
|
<div class="md-sidebar__inner">
|
|
|
|
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
|
|
|
|
|
|
|
|
|
|
|
|
<label class="md-nav__title" for="__toc">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
Table of contents
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#auth-router" class="md-nav__link">
|
|
Auth router
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="Auth router">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#post-login" class="md-nav__link">
|
|
POST /login
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#post-logout" class="md-nav__link">
|
|
POST /logout
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#register-router" class="md-nav__link">
|
|
Register router
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="Register router">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#post-register" class="md-nav__link">
|
|
POST /register
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#reset-password-router" class="md-nav__link">
|
|
Reset password router
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="Reset password router">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#post-forgot-password" class="md-nav__link">
|
|
POST /forgot-password
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#post-reset-password" class="md-nav__link">
|
|
POST /reset-password
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#oauth-router" class="md-nav__link">
|
|
OAuth router
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="OAuth router">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#get-authorize" class="md-nav__link">
|
|
GET /authorize
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#get-callback" class="md-nav__link">
|
|
GET /callback
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#users-router" class="md-nav__link">
|
|
Users router
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="Users router">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#get-me" class="md-nav__link">
|
|
GET /me
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#patch-me" class="md-nav__link">
|
|
PATCH /me
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#get-user_id" class="md-nav__link">
|
|
GET /{user_id}
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#patch-user_id" class="md-nav__link">
|
|
PATCH /{user_id}
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#delete-user_id" class="md-nav__link">
|
|
DELETE /{user_id}
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
</nav>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<div class="md-content">
|
|
<article class="md-content__inner md-typeset">
|
|
|
|
|
|
|
|
<h1 id="routes">Routes<a class="headerlink" href="#routes" title="Permanent link">¶</a></h1>
|
|
<p>You'll find here the routes exposed by <strong>FastAPI Users</strong>. Note that you can also review them through the <a href="https://fastapi.tiangolo.com/tutorial/first-steps/#interactive-api-docs">interactive API docs</a>.</p>
|
|
<h2 id="auth-router">Auth router<a class="headerlink" href="#auth-router" title="Permanent link">¶</a></h2>
|
|
<p>Each <a href="../../configuration/authentication/">authentication backend</a> you <a href="../../configuration/routers/auth/">generate a router for</a> will produce the following routes. Take care about the prefix you gave it, especially if you have several backends.</p>
|
|
<h3 id="post-login"><code>POST /login</code><a class="headerlink" href="#post-login" title="Permanent link">¶</a></h3>
|
|
<p>Login a user against the method named <code>name</code>. Check the corresponding <a href="../../configuration/authentication/">authentication method</a> to view the success response.</p>
|
|
<div class="admonition abstract">
|
|
<p class="admonition-title">Payload (<code>application/x-www-form-urlencoded</code>)</p>
|
|
<div class="highlight"><pre><span></span><code>username=king.arthur@camelot.bt&password=guinevere
|
|
</code></pre></div>
|
|
</div>
|
|
<div class="admonition fail">
|
|
<p class="admonition-title"><code>422 Validation Error</code></p>
|
|
</div>
|
|
<div class="admonition fail">
|
|
<p class="admonition-title"><code>400 Bad Request</code></p>
|
|
<p>Bad credentials or the user is inactive.</p>
|
|
<div class="highlight"><pre><span></span><code><span class="p">{</span>
|
|
<span class="nt">"detail"</span><span class="p">:</span> <span class="s2">"LOGIN_BAD_CREDENTIALS"</span>
|
|
<span class="p">}</span>
|
|
</code></pre></div>
|
|
</div>
|
|
<h3 id="post-logout"><code>POST /logout</code><a class="headerlink" href="#post-logout" title="Permanent link">¶</a></h3>
|
|
<p>Logout the authenticated user against the method named <code>name</code>. Check the corresponding <a href="../../configuration/authentication/">authentication method</a> to view the success response.</p>
|
|
<div class="admonition fail">
|
|
<p class="admonition-title"><code>401 Unauthorized</code></p>
|
|
<p>Missing token or inactive user.</p>
|
|
</div>
|
|
<div class="admonition success">
|
|
<p class="admonition-title"><code>200 OK</code></p>
|
|
<p>The logout process was successful.</p>
|
|
</div>
|
|
<div class="admonition tip">
|
|
<p class="admonition-title">Tip</p>
|
|
<p>Some backend (like JWT) won't produce this route.</p>
|
|
</div>
|
|
<h2 id="register-router">Register router<a class="headerlink" href="#register-router" title="Permanent link">¶</a></h2>
|
|
<h3 id="post-register"><code>POST /register</code><a class="headerlink" href="#post-register" title="Permanent link">¶</a></h3>
|
|
<p>Register a new user. Will call the <code>after_register</code> <a href="../../configuration/routers/register/#after-register">handler</a> on successful registration.</p>
|
|
<div class="admonition abstract">
|
|
<p class="admonition-title">Payload</p>
|
|
<div class="highlight"><pre><span></span><code><span class="p">{</span>
|
|
<span class="nt">"email"</span><span class="p">:</span> <span class="s2">"king.arthur@camelot.bt"</span><span class="p">,</span>
|
|
<span class="nt">"password"</span><span class="p">:</span> <span class="s2">"guinevere"</span>
|
|
<span class="p">}</span>
|
|
</code></pre></div>
|
|
</div>
|
|
<div class="admonition success">
|
|
<p class="admonition-title"><code>201 Created</code></p>
|
|
<div class="highlight"><pre><span></span><code><span class="p">{</span>
|
|
<span class="nt">"id"</span><span class="p">:</span> <span class="s2">"57cbb51a-ab71-4009-8802-3f54b4f2e23"</span><span class="p">,</span>
|
|
<span class="nt">"email"</span><span class="p">:</span> <span class="s2">"king.arthur@camelot.bt"</span><span class="p">,</span>
|
|
<span class="nt">"is_active"</span><span class="p">:</span> <span class="kc">true</span><span class="p">,</span>
|
|
<span class="nt">"is_superuser"</span><span class="p">:</span> <span class="kc">false</span>
|
|
<span class="p">}</span>
|
|
</code></pre></div>
|
|
</div>
|
|
<div class="admonition fail">
|
|
<p class="admonition-title"><code>422 Validation Error</code></p>
|
|
</div>
|
|
<div class="admonition fail">
|
|
<p class="admonition-title"><code>400 Bad Request</code></p>
|
|
<p>A user already exists with this email.</p>
|
|
<div class="highlight"><pre><span></span><code><span class="p">{</span>
|
|
<span class="nt">"detail"</span><span class="p">:</span> <span class="s2">"REGISTER_USER_ALREADY_EXISTS"</span>
|
|
<span class="p">}</span>
|
|
</code></pre></div>
|
|
</div>
|
|
<h2 id="reset-password-router">Reset password router<a class="headerlink" href="#reset-password-router" title="Permanent link">¶</a></h2>
|
|
<h3 id="post-forgot-password"><code>POST /forgot-password</code><a class="headerlink" href="#post-forgot-password" title="Permanent link">¶</a></h3>
|
|
<p>Request a reset password procedure. Will generate a temporary token and call the <code>after_forgot_password</code> <a href="../../configuration/routers/reset/#after-forgot-password">handlers</a> if the user exists.</p>
|
|
<p>To prevent malicious users from guessing existing users in your databse, the route will always return a <code>202 Accepted</code> response, even if the user requested does not exist.</p>
|
|
<div class="admonition abstract">
|
|
<p class="admonition-title">Payload</p>
|
|
<div class="highlight"><pre><span></span><code><span class="p">{</span>
|
|
<span class="nt">"email"</span><span class="p">:</span> <span class="s2">"king.arthur@camelot.bt"</span>
|
|
<span class="p">}</span>
|
|
</code></pre></div>
|
|
</div>
|
|
<div class="admonition success">
|
|
<p class="admonition-title"><code>202 Accepted</code></p>
|
|
</div>
|
|
<h3 id="post-reset-password"><code>POST /reset-password</code><a class="headerlink" href="#post-reset-password" title="Permanent link">¶</a></h3>
|
|
<p>Reset a password. Requires the token generated by the <code>/forgot-password</code> route.</p>
|
|
<div class="admonition abstract">
|
|
<p class="admonition-title">Payload</p>
|
|
<div class="highlight"><pre><span></span><code><span class="p">{</span>
|
|
<span class="nt">"token"</span><span class="p">:</span> <span class="s2">"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoiOTIyMWZmYzktNjQwZi00MzcyLTg2ZDMtY2U2NDJjYmE1NjAzIiwiYXVkIjoiZmFzdGFwaS11c2VyczphdXRoIiwiZXhwIjoxNTcxNTA0MTkzfQ.M10bjOe45I5Ncu_uXvOmVV8QxnL-nZfcH96U90JaocI"</span><span class="p">,</span>
|
|
<span class="nt">"password"</span><span class="p">:</span> <span class="s2">"merlin"</span>
|
|
<span class="p">}</span>
|
|
</code></pre></div>
|
|
</div>
|
|
<div class="admonition success">
|
|
<p class="admonition-title"><code>200 OK</code></p>
|
|
</div>
|
|
<div class="admonition fail">
|
|
<p class="admonition-title"><code>422 Validation Error</code></p>
|
|
</div>
|
|
<div class="admonition fail">
|
|
<p class="admonition-title"><code>400 Bad Request</code></p>
|
|
<p>Bad or expired token.</p>
|
|
<div class="highlight"><pre><span></span><code><span class="p">{</span>
|
|
<span class="nt">"detail"</span><span class="p">:</span> <span class="s2">"RESET_PASSWORD_BAD_TOKEN"</span>
|
|
<span class="p">}</span>
|
|
</code></pre></div>
|
|
</div>
|
|
<h2 id="oauth-router">OAuth router<a class="headerlink" href="#oauth-router" title="Permanent link">¶</a></h2>
|
|
<p>Each OAuth router you define will expose the two following routes.</p>
|
|
<h3 id="get-authorize"><code>GET /authorize</code><a class="headerlink" href="#get-authorize" title="Permanent link">¶</a></h3>
|
|
<p>Return the authorization URL for the OAuth service where you should redirect your user.</p>
|
|
<div class="admonition abstract">
|
|
<p class="admonition-title">Query parameters</p>
|
|
<ul>
|
|
<li><code>authentication_backend</code>: <code>name</code> property of a defined <a href="../../configuration/authentication/">authentication method</a> to use to authenticate the user on successful callback. Usually <code>jwt</code> or <code>cookie</code>.</li>
|
|
<li><code>scopes</code>: Optional list of scopes to ask for. Expected format: <code>scopes=a&scopes=b</code>.</li>
|
|
</ul>
|
|
</div>
|
|
<div class="admonition success">
|
|
<p class="admonition-title"><code>200 OK</code></p>
|
|
<div class="highlight"><pre><span></span><code><span class="p">{</span>
|
|
<span class="nt">"authorization_url"</span><span class="p">:</span> <span class="s2">"https://www.tintagel.bt/oauth/authorize?client_id=CLIENT_ID&scopes=a+b&redirect_uri=https://www.camelot.bt/oauth/callback"</span>
|
|
<span class="p">}</span>
|
|
</code></pre></div>
|
|
</div>
|
|
<div class="admonition fail">
|
|
<p class="admonition-title"><code>422 Validation Error</code></p>
|
|
</div>
|
|
<div class="admonition fail">
|
|
<p class="admonition-title"><code>400 Bad Request</code></p>
|
|
<p>Unknown authentication backend.</p>
|
|
</div>
|
|
<h3 id="get-callback"><code>GET /callback</code><a class="headerlink" href="#get-callback" title="Permanent link">¶</a></h3>
|
|
<p>Handle the OAuth callback.</p>
|
|
<div class="admonition abstract">
|
|
<p class="admonition-title">Query parameters</p>
|
|
<ul>
|
|
<li><code>code</code>: OAuth callback code.</li>
|
|
<li><code>state</code>: State token.</li>
|
|
<li><code>error</code>: OAuth error.</li>
|
|
</ul>
|
|
</div>
|
|
<p>Depending on the situation, several things can happen:</p>
|
|
<ul>
|
|
<li>The OAuth account exists in database and is linked to a user:<ul>
|
|
<li>OAuth account is updated in database with fresh access token.</li>
|
|
<li>The user is authenticated following the chosen <a href="../../configuration/authentication/">authentication method</a>.</li>
|
|
</ul>
|
|
</li>
|
|
<li>The OAuth account doesn't exist in database but a user with the same email address exists:<ul>
|
|
<li>OAuth account is linked to the user.</li>
|
|
<li>The user is authenticated following the chosen <a href="../../configuration/authentication/">authentication method</a>.</li>
|
|
</ul>
|
|
</li>
|
|
<li>The OAuth account doesn't exist in database and no user with the email address exists:<ul>
|
|
<li>A new user is created and linked to the OAuth account.</li>
|
|
<li>The user is authenticated following the chosen <a href="../../configuration/authentication/">authentication method</a>.</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<h2 id="users-router">Users router<a class="headerlink" href="#users-router" title="Permanent link">¶</a></h2>
|
|
<h3 id="get-me"><code>GET /me</code><a class="headerlink" href="#get-me" title="Permanent link">¶</a></h3>
|
|
<p>Return the current authenticated active user.</p>
|
|
<div class="admonition success">
|
|
<p class="admonition-title"><code>200 OK</code></p>
|
|
<div class="highlight"><pre><span></span><code><span class="p">{</span>
|
|
<span class="nt">"id"</span><span class="p">:</span> <span class="s2">"57cbb51a-ab71-4009-8802-3f54b4f2e23"</span><span class="p">,</span>
|
|
<span class="nt">"email"</span><span class="p">:</span> <span class="s2">"king.arthur@camelot.bt"</span><span class="p">,</span>
|
|
<span class="nt">"is_active"</span><span class="p">:</span> <span class="kc">true</span><span class="p">,</span>
|
|
<span class="nt">"is_superuser"</span><span class="p">:</span> <span class="kc">false</span>
|
|
<span class="p">}</span>
|
|
</code></pre></div>
|
|
</div>
|
|
<div class="admonition fail">
|
|
<p class="admonition-title"><code>401 Unauthorized</code></p>
|
|
<p>Missing token or inactive user.</p>
|
|
</div>
|
|
<h3 id="patch-me"><code>PATCH /me</code><a class="headerlink" href="#patch-me" title="Permanent link">¶</a></h3>
|
|
<p>Update the current authenticated active user.</p>
|
|
<div class="admonition abstract">
|
|
<p class="admonition-title">Payload</p>
|
|
<div class="highlight"><pre><span></span><code><span class="p">{</span>
|
|
<span class="nt">"email"</span><span class="p">:</span> <span class="s2">"king.arthur@tintagel.bt"</span><span class="p">,</span>
|
|
<span class="nt">"password"</span><span class="p">:</span> <span class="s2">"merlin"</span>
|
|
<span class="p">}</span>
|
|
</code></pre></div>
|
|
</div>
|
|
<div class="admonition success">
|
|
<p class="admonition-title"><code>200 OK</code></p>
|
|
<div class="highlight"><pre><span></span><code><span class="p">{</span>
|
|
<span class="nt">"id"</span><span class="p">:</span> <span class="s2">"57cbb51a-ab71-4009-8802-3f54b4f2e23"</span><span class="p">,</span>
|
|
<span class="nt">"email"</span><span class="p">:</span> <span class="s2">"king.arthur@tintagel.bt"</span><span class="p">,</span>
|
|
<span class="nt">"is_active"</span><span class="p">:</span> <span class="kc">true</span><span class="p">,</span>
|
|
<span class="nt">"is_superuser"</span><span class="p">:</span> <span class="kc">false</span>
|
|
<span class="p">}</span>
|
|
</code></pre></div>
|
|
</div>
|
|
<div class="admonition fail">
|
|
<p class="admonition-title"><code>401 Unauthorized</code></p>
|
|
<p>Missing token or inactive user.</p>
|
|
</div>
|
|
<h3 id="get-user_id"><code>GET /{user_id}</code><a class="headerlink" href="#get-user_id" title="Permanent link">¶</a></h3>
|
|
<p>Return the user with id <code>user_id</code>.</p>
|
|
<div class="admonition success">
|
|
<p class="admonition-title"><code>200 OK</code></p>
|
|
<div class="highlight"><pre><span></span><code><span class="p">{</span>
|
|
<span class="nt">"id"</span><span class="p">:</span> <span class="s2">"57cbb51a-ab71-4009-8802-3f54b4f2e23"</span><span class="p">,</span>
|
|
<span class="nt">"email"</span><span class="p">:</span> <span class="s2">"king.arthur@camelot.bt"</span><span class="p">,</span>
|
|
<span class="nt">"is_active"</span><span class="p">:</span> <span class="kc">true</span><span class="p">,</span>
|
|
<span class="nt">"is_superuser"</span><span class="p">:</span> <span class="kc">false</span>
|
|
<span class="p">}</span>
|
|
</code></pre></div>
|
|
</div>
|
|
<div class="admonition fail">
|
|
<p class="admonition-title"><code>401 Unauthorized</code></p>
|
|
<p>Missing token or inactive user.</p>
|
|
</div>
|
|
<div class="admonition fail">
|
|
<p class="admonition-title"><code>403 Forbidden</code></p>
|
|
<p>Not a superuser.</p>
|
|
</div>
|
|
<div class="admonition fail">
|
|
<p class="admonition-title"><code>404 Not found</code></p>
|
|
<p>The user does not exist.</p>
|
|
</div>
|
|
<h3 id="patch-user_id"><code>PATCH /{user_id}</code><a class="headerlink" href="#patch-user_id" title="Permanent link">¶</a></h3>
|
|
<p>Update the user with id <code>user_id</code>.</p>
|
|
<div class="admonition abstract">
|
|
<p class="admonition-title">Payload</p>
|
|
<div class="highlight"><pre><span></span><code><span class="p">{</span>
|
|
<span class="nt">"email"</span><span class="p">:</span> <span class="s2">"king.arthur@tintagel.bt"</span><span class="p">,</span>
|
|
<span class="nt">"password"</span><span class="p">:</span> <span class="s2">"merlin"</span><span class="p">,</span>
|
|
<span class="nt">"is_active"</span><span class="p">:</span> <span class="kc">false</span><span class="p">,</span>
|
|
<span class="nt">"is_superuser"</span><span class="p">:</span> <span class="kc">true</span>
|
|
<span class="p">}</span>
|
|
</code></pre></div>
|
|
</div>
|
|
<div class="admonition success">
|
|
<p class="admonition-title"><code>200 OK</code></p>
|
|
<div class="highlight"><pre><span></span><code><span class="p">{</span>
|
|
<span class="nt">"id"</span><span class="p">:</span> <span class="s2">"57cbb51a-ab71-4009-8802-3f54b4f2e23"</span><span class="p">,</span>
|
|
<span class="nt">"email"</span><span class="p">:</span> <span class="s2">"king.arthur@camelot.bt"</span><span class="p">,</span>
|
|
<span class="nt">"is_active"</span><span class="p">:</span> <span class="kc">false</span><span class="p">,</span>
|
|
<span class="nt">"is_superuser"</span><span class="p">:</span> <span class="kc">true</span>
|
|
<span class="p">}</span>
|
|
</code></pre></div>
|
|
</div>
|
|
<div class="admonition fail">
|
|
<p class="admonition-title"><code>401 Unauthorized</code></p>
|
|
<p>Missing token or inactive user.</p>
|
|
</div>
|
|
<div class="admonition fail">
|
|
<p class="admonition-title"><code>403 Forbidden</code></p>
|
|
<p>Not a superuser.</p>
|
|
</div>
|
|
<div class="admonition fail">
|
|
<p class="admonition-title"><code>404 Not found</code></p>
|
|
<p>The user does not exist.</p>
|
|
</div>
|
|
<h3 id="delete-user_id"><code>DELETE /{user_id}</code><a class="headerlink" href="#delete-user_id" title="Permanent link">¶</a></h3>
|
|
<p>Delete the user with id <code>user_id</code>.</p>
|
|
<div class="admonition success">
|
|
<p class="admonition-title"><code>204 No content</code></p>
|
|
</div>
|
|
<div class="admonition fail">
|
|
<p class="admonition-title"><code>401 Unauthorized</code></p>
|
|
<p>Missing token or inactive user.</p>
|
|
</div>
|
|
<div class="admonition fail">
|
|
<p class="admonition-title"><code>403 Forbidden</code></p>
|
|
<p>Not a superuser.</p>
|
|
</div>
|
|
<div class="admonition fail">
|
|
<p class="admonition-title"><code>404 Not found</code></p>
|
|
<p>The user does not exist.</p>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</article>
|
|
</div>
|
|
</div>
|
|
</main>
|
|
|
|
|
|
<footer class="md-footer">
|
|
|
|
<div class="md-footer-nav">
|
|
<nav class="md-footer-nav__inner md-grid" aria-label="Footer">
|
|
|
|
<a href="../flow/" class="md-footer-nav__link md-footer-nav__link--prev" rel="prev">
|
|
<div class="md-footer-nav__button md-icon">
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12z"/></svg>
|
|
</div>
|
|
<div class="md-footer-nav__title">
|
|
<div class="md-ellipsis">
|
|
<span class="md-footer-nav__direction">
|
|
Previous
|
|
</span>
|
|
Flow
|
|
</div>
|
|
</div>
|
|
</a>
|
|
|
|
|
|
<a href="../dependency-callables/" class="md-footer-nav__link md-footer-nav__link--next" rel="next">
|
|
<div class="md-footer-nav__title">
|
|
<div class="md-ellipsis">
|
|
<span class="md-footer-nav__direction">
|
|
Next
|
|
</span>
|
|
Dependency callables
|
|
</div>
|
|
</div>
|
|
<div class="md-footer-nav__button md-icon">
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M4 11v2h12l-5.5 5.5 1.42 1.42L19.84 12l-7.92-7.92L10.5 5.5 16 11H4z"/></svg>
|
|
</div>
|
|
</a>
|
|
|
|
</nav>
|
|
</div>
|
|
|
|
<div class="md-footer-meta md-typeset">
|
|
<div class="md-footer-meta__inner md-grid">
|
|
<div class="md-footer-copyright">
|
|
|
|
Made with
|
|
<a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
|
|
Material for MkDocs
|
|
</a>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
</footer>
|
|
|
|
</div>
|
|
|
|
<script src="../../assets/javascripts/vendor.fd16492e.min.js"></script>
|
|
<script src="../../assets/javascripts/bundle.7836ba4d.min.js"></script><script id="__lang" type="application/json">{"clipboard.copy": "Copy to clipboard", "clipboard.copied": "Copied to clipboard", "search.config.lang": "en", "search.config.pipeline": "trimmer, stopWordFilter", "search.config.separator": "[\\s\\-]+", "search.placeholder": "Search", "search.result.placeholder": "Type to start searching", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.term.missing": "Missing"}</script>
|
|
|
|
<script>
|
|
app = initialize({
|
|
base: "../..",
|
|
features: [],
|
|
search: Object.assign({
|
|
worker: "../../assets/javascripts/worker/search.4ac00218.min.js"
|
|
}, typeof search !== "undefined" && search)
|
|
})
|
|
</script>
|
|
|
|
|
|
</body>
|
|
</html> |