python/fastapi-users
1
0
Fork 0
mirror of https://github.com/fastapi-users/fastapi-users.git synced 2026-03-13 07:49:55 +08:00
Code Issues Packages Projects Releases Wiki Activity
Files
d149530967201d3d13fba2dd5e293d1a2cb7eb92
fastapi-users/usage/routes/index.html

1087 lines
47 KiB
HTML
Raw Blame History

<!DOCTYPE html>
<html class="no-js" lang="en">
<head>
<meta charset="utf-8"/>
<meta content="width=device-width,initial-scale=1" name="viewport"/>
<meta content="Ready-to-use and customizable users management for FastAPI" name="description"/>
<link href="../../favicon.png" rel="icon"/>
<meta content="mkdocs-1.2.2, mkdocs-material-7.3.2" name="generator"/>
<title>Routes - FastAPI Users</title>
<link href="../../assets/stylesheets/main.24c991ad.min.css" rel="stylesheet"/>
<link href="../../assets/stylesheets/palette.3f5d1f46.min.css" rel="stylesheet"/>
<link crossorigin="" href="https://fonts.gstatic.com" rel="preconnect"/>
<link href="https://fonts.googleapis.com/css?family=Roboto:300,400,400i,700%7CRoboto+Mono&amp;display=fallback" rel="stylesheet"/>
<style>:root{--md-text-font-family:"Roboto";--md-code-font-family:"Roboto Mono"}</style>
</head>
<body data-md-color-accent="red" data-md-color-primary="red" data-md-color-scheme="default" dir="ltr">
<script>function __prefix(e){return new URL("../..",location).pathname+"."+e}function __get(e,t=localStorage){return JSON.parse(t.getItem(__prefix(e)))}</script>
<script>var palette=__get("__palette");if(null!==palette&&"object"==typeof palette.color)for(var key in palette.color)document.body.setAttribute("data-md-color-"+key,palette.color[key])</script>
<input autocomplete="off" class="md-toggle" data-md-toggle="drawer" id="__drawer" type="checkbox"/>
<input autocomplete="off" class="md-toggle" data-md-toggle="search" id="__search" type="checkbox"/>
<label class="md-overlay" for="__drawer"></label>
<div data-md-component="skip">
<a class="md-skip" href="#routes">
Skip to content
</a>
</div>
<div data-md-component="announce">
</div>
<header class="md-header" data-md-component="header">
<nav aria-label="Header" class="md-header__inner md-grid">
<a aria-label="FastAPI Users" class="md-header__button md-logo" data-md-component="logo" href="../.." title="FastAPI Users">
<svg viewbox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><path d="M16.5 12A2.5 2.5 0 0 0 19 9.5 2.5 2.5 0 0 0 16.5 7 2.5 2.5 0 0 0 14 9.5a2.5 2.5 0 0 0 2.5 2.5M9 11a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 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"></path></svg>
</a>
<label class="md-header__button md-icon" for="__drawer">
<svg viewbox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2z"></path></svg>
</label>
<div class="md-header__title" data-md-component="header-title">
<div class="md-header__ellipsis">
<div class="md-header__topic">
<span class="md-ellipsis">
FastAPI Users
</span>
</div>
<div class="md-header__topic" data-md-component="header-topic">
<span class="md-ellipsis">
Routes
</span>
</div>
</div>
</div>
<form class="md-header__option" data-md-component="palette">
<input aria-label="Switch to dark mode" class="md-option" data-md-color-accent="red" data-md-color-media="" data-md-color-primary="red" data-md-color-scheme="default" id="__palette_1" name="__palette" type="radio"/>
<label class="md-header__button md-icon" for="__palette_2" hidden="" title="Switch to dark mode">
<svg viewbox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><path d="M12 2a7 7 0 0 0-7 7c0 2.38 1.19 4.47 3 5.74V17a1 1 0 0 0 1 1h6a1 1 0 0 0 1-1v-2.26c1.81-1.27 3-3.36 3-5.74a7 7 0 0 0-7-7M9 21a1 1 0 0 0 1 1h4a1 1 0 0 0 1-1v-1H9v1z"></path></svg>
</label>
<input aria-label="Switch to light mode" class="md-option" data-md-color-accent="red" data-md-color-media="" data-md-color-primary="red" data-md-color-scheme="slate" id="__palette_2" name="__palette" type="radio"/>
<label class="md-header__button md-icon" for="__palette_1" hidden="" title="Switch to light mode">
<svg viewbox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><path d="M12 2a7 7 0 0 1 7 7c0 2.38-1.19 4.47-3 5.74V17a1 1 0 0 1-1 1H9a1 1 0 0 1-1-1v-2.26C6.19 13.47 5 11.38 5 9a7 7 0 0 1 7-7M9 21v-1h6v1a1 1 0 0 1-1 1h-4a1 1 0 0 1-1-1m3-17a5 5 0 0 0-5 5c0 2.05 1.23 3.81 3 4.58V16h4v-2.42c1.77-.77 3-2.53 3-4.58a5 5 0 0 0-5-5z"></path></svg>
</label>
</form>
<label class="md-header__button md-icon" for="__search">
<svg viewbox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><path d="M9.5 3A6.5 6.5 0 0 1 16 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 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"></path></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 aria-label="Search" autocapitalize="off" autocomplete="off" autocorrect="off" class="md-search__input" data-md-component="search-query" name="query" placeholder="Search" required="" spellcheck="false" type="text"/>
<label class="md-search__icon md-icon" for="__search">
<svg viewbox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><path d="M9.5 3A6.5 6.5 0 0 1 16 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 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"></path></svg>
<svg viewbox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12z"></path></svg>
</label>
<nav aria-label="Search" class="md-search__options">
<button aria-label="Clear" class="md-search__icon md-icon" tabindex="-1" type="reset">
<svg viewbox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><path d="M19 6.41 17.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"></path></svg>
</button>
</nav>
</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__source">
<a class="md-source" data-md-component="source" href="https://github.com/fastapi-users/fastapi-users" title="Go to repository">
<div class="md-source__icon md-icon">
<svg viewbox="0 0 448 512" xmlns="http://www.w3.org/2000/svg"><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-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 0 1-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 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"></path></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="sidebar" data-md-type="navigation">
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
<nav aria-label="Navigation" class="md-nav md-nav--primary" data-md-level="0">
<label class="md-nav__title" for="__drawer">
<a aria-label="FastAPI Users" class="md-nav__button md-logo" data-md-component="logo" href="../.." title="FastAPI Users">
<svg viewbox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><path d="M16.5 12A2.5 2.5 0 0 0 19 9.5 2.5 2.5 0 0 0 16.5 7 2.5 2.5 0 0 0 14 9.5a2.5 2.5 0 0 0 2.5 2.5M9 11a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 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"></path></svg>
</a>
FastAPI Users
</label>
<div class="md-nav__source">
<a class="md-source" data-md-component="source" href="https://github.com/fastapi-users/fastapi-users" title="Go to repository">
<div class="md-source__icon md-icon">
<svg viewbox="0 0 448 512" xmlns="http://www.w3.org/2000/svg"><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-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 0 1-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 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"></path></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 class="md-nav__link" href="../..">
About
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="../../installation/">
Installation
</a>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3" id="__nav_3" type="checkbox"/>
<label class="md-nav__link" for="__nav_3">
Configuration
<span class="md-nav__icon md-icon"></span>
</label>
<nav aria-label="Configuration" class="md-nav" 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 class="md-nav__link" href="../../configuration/overview/">
Overview
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="../../configuration/models/">
Models
</a>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3_3" id="__nav_3_3" type="checkbox"/>
<label class="md-nav__link" for="__nav_3_3">
Database adapters
<span class="md-nav__icon md-icon"></span>
</label>
<nav aria-label="Database adapters" class="md-nav" data-md-level="2">
<label class="md-nav__title" for="__nav_3_3">
<span class="md-nav__icon md-icon"></span>
Database adapters
</label>
<ul class="md-nav__list" data-md-scrollfix="">
<li class="md-nav__item">
<a class="md-nav__link" href="../../configuration/databases/sqlalchemy/">
SQLAlchemy
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="../../configuration/databases/mongodb/">
MongoDB
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="../../configuration/databases/tortoise/">
Tortoise ORM
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="../../configuration/databases/ormar/">
Ormar
</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" id="__nav_3_4" type="checkbox"/>
<label class="md-nav__link" for="__nav_3_4">
Authentication backends
<span class="md-nav__icon md-icon"></span>
</label>
<nav aria-label="Authentication backends" class="md-nav" data-md-level="2">
<label class="md-nav__title" for="__nav_3_4">
<span class="md-nav__icon md-icon"></span>
Authentication backends
</label>
<ul class="md-nav__list" data-md-scrollfix="">
<li class="md-nav__item">
<a class="md-nav__link" href="../../configuration/authentication/">
Introduction
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="../../configuration/authentication/jwt/">
JWT
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="../../configuration/authentication/cookie/">
Cookie
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="../../configuration/user-manager/">
UserManager
</a>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3_6" id="__nav_3_6" type="checkbox"/>
<label class="md-nav__link" for="__nav_3_6">
Routers
<span class="md-nav__icon md-icon"></span>
</label>
<nav aria-label="Routers" class="md-nav" data-md-level="2">
<label class="md-nav__title" for="__nav_3_6">
<span class="md-nav__icon md-icon"></span>
Routers
</label>
<ul class="md-nav__list" data-md-scrollfix="">
<li class="md-nav__item">
<a class="md-nav__link" href="../../configuration/routers/">
Introduction
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="../../configuration/routers/auth/">
Auth router
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="../../configuration/routers/register/">
Register routes
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="../../configuration/routers/verify/">
Verify router
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="../../configuration/routers/reset/">
Reset password router
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="../../configuration/routers/users/">
Users router
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="../../configuration/full-example/">
Full example
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="../../configuration/oauth/">
OAuth2
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--active md-nav__item--nested">
<input checked="" class="md-nav__toggle md-toggle" data-md-toggle="__nav_4" id="__nav_4" type="checkbox"/>
<label class="md-nav__link" for="__nav_4">
Usage
<span class="md-nav__icon md-icon"></span>
</label>
<nav aria-label="Usage" class="md-nav" 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 class="md-nav__link" href="../flow/">
Flow
</a>
</li>
<li class="md-nav__item md-nav__item--active">
<input class="md-nav__toggle md-toggle" data-md-toggle="toc" id="__toc" type="checkbox"/>
<label class="md-nav__link md-nav__link--active" for="__toc">
Routes
<span class="md-nav__icon md-icon"></span>
</label>
<a class="md-nav__link md-nav__link--active" href="./">
Routes
</a>
<nav aria-label="Table of contents" class="md-nav md-nav--secondary">
<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-component="toc" data-md-scrollfix="">
<li class="md-nav__item">
<a class="md-nav__link" href="#auth-router">
Auth router
</a>
<nav aria-label="Auth router" class="md-nav">
<ul class="md-nav__list">
<li class="md-nav__item">
<a class="md-nav__link" href="#post-login">
POST /login
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#post-logout">
POST /logout
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#register-router">
Register router
</a>
<nav aria-label="Register router" class="md-nav">
<ul class="md-nav__list">
<li class="md-nav__item">
<a class="md-nav__link" href="#post-register">
POST /register
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#reset-password-router">
Reset password router
</a>
<nav aria-label="Reset password router" class="md-nav">
<ul class="md-nav__list">
<li class="md-nav__item">
<a class="md-nav__link" href="#post-forgot-password">
POST /forgot-password
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#post-reset-password">
POST /reset-password
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#verify-router">
Verify router
</a>
<nav aria-label="Verify router" class="md-nav">
<ul class="md-nav__list">
<li class="md-nav__item">
<a class="md-nav__link" href="#post-request-verify-token">
POST /request-verify-token
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#post-verify">
POST /verify
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#oauth-router">
OAuth router
</a>
<nav aria-label="OAuth router" class="md-nav">
<ul class="md-nav__list">
<li class="md-nav__item">
<a class="md-nav__link" href="#get-authorize">
GET /authorize
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#get-callback">
GET /callback
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#users-router">
Users router
</a>
<nav aria-label="Users router" class="md-nav">
<ul class="md-nav__list">
<li class="md-nav__item">
<a class="md-nav__link" href="#get-me">
GET /me
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#patch-me">
PATCH /me
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#get-user_id">
GET /{user_id}
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#patch-user_id">
PATCH /{user_id}
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#delete-user_id">
DELETE /{user_id}
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="../current-user/">
Get current user
</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" id="__nav_5" type="checkbox"/>
<label class="md-nav__link" for="__nav_5">
Migration
<span class="md-nav__icon md-icon"></span>
</label>
<nav aria-label="Migration" class="md-nav" 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 class="md-nav__link" href="../../migration/08_to_1x/">
0.8.x ➡️ 1.x.x
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="../../migration/1x_to_2x/">
1.x.x ➡️ 2.x.x
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="../../migration/2x_to_3x/">
2.x.x ➡️ 3.x.x
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="../../migration/3x_to_4x/">
3.x.x ➡️ 4.x.x
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="../../migration/4x_to_5x/">
4.x.x ➡️ 5.x.x
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="../../migration/6x_to_7x/">
6.x.x ➡️ 7.x.x
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="../../migration/7x_to_8x/">
7.x.x ➡️ 8.x.x
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc">
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
<nav aria-label="Table of contents" class="md-nav md-nav--secondary">
<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-component="toc" data-md-scrollfix="">
<li class="md-nav__item">
<a class="md-nav__link" href="#auth-router">
Auth router
</a>
<nav aria-label="Auth router" class="md-nav">
<ul class="md-nav__list">
<li class="md-nav__item">
<a class="md-nav__link" href="#post-login">
POST /login
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#post-logout">
POST /logout
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#register-router">
Register router
</a>
<nav aria-label="Register router" class="md-nav">
<ul class="md-nav__list">
<li class="md-nav__item">
<a class="md-nav__link" href="#post-register">
POST /register
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#reset-password-router">
Reset password router
</a>
<nav aria-label="Reset password router" class="md-nav">
<ul class="md-nav__list">
<li class="md-nav__item">
<a class="md-nav__link" href="#post-forgot-password">
POST /forgot-password
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#post-reset-password">
POST /reset-password
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#verify-router">
Verify router
</a>
<nav aria-label="Verify router" class="md-nav">
<ul class="md-nav__list">
<li class="md-nav__item">
<a class="md-nav__link" href="#post-request-verify-token">
POST /request-verify-token
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#post-verify">
POST /verify
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#oauth-router">
OAuth router
</a>
<nav aria-label="OAuth router" class="md-nav">
<ul class="md-nav__list">
<li class="md-nav__item">
<a class="md-nav__link" href="#get-authorize">
GET /authorize
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#get-callback">
GET /callback
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#users-router">
Users router
</a>
<nav aria-label="Users router" class="md-nav">
<ul class="md-nav__list">
<li class="md-nav__item">
<a class="md-nav__link" href="#get-me">
GET /me
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#patch-me">
PATCH /me
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#get-user_id">
GET /{user_id}
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#patch-user_id">
PATCH /{user_id}
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#delete-user_id">
DELETE /{user_id}
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-content" data-md-component="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&amp;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>
<div class="admonition fail">
<p class="admonition-title"><code>400 Bad Request</code></p>
<p>The user is not verified.</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_USER_NOT_VERIFIED"</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>
<div class="admonition fail">
<p class="admonition-title"><code>400 Bad Request</code></p>
<p><a href="../configuration/password-validation.md">Password validation</a> failed.</p>
<div class="highlight"><pre><span></span><code><span class="p">{</span>
<span class="nt">"detail"</span><span class="p">:</span> <span class="p">{</span>
<span class="nt">"code"</span><span class="p">:</span> <span class="s2">"RESET_PASSWORD_INVALID_PASSWORD"</span><span class="p">,</span>
<span class="nt">"reason"</span><span class="p">:</span> <span class="s2">"Password should be at least 3 characters"</span>
<span class="p">}</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">handler</a> if the user exists.</p>
<p>To prevent malicious users from guessing existing users in your database, 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>
<div class="admonition fail">
<p class="admonition-title"><code>400 Bad Request</code></p>
<p><a href="../configuration/password-validation.md">Password validation</a> failed.</p>
<div class="highlight"><pre><span></span><code><span class="p">{</span>
<span class="nt">"detail"</span><span class="p">:</span> <span class="p">{</span>
<span class="nt">"code"</span><span class="p">:</span> <span class="s2">"REGISTER_INVALID_PASSWORD"</span><span class="p">,</span>
<span class="nt">"reason"</span><span class="p">:</span> <span class="s2">"Password should be at least 3 characters"</span>
<span class="p">}</span>
<span class="p">}</span>
</code></pre></div>
</div>
<h2 id="verify-router">Verify router<a class="headerlink" href="#verify-router" title="Permanent link"></a></h2>
<h3 id="post-request-verify-token"><code>POST /request-verify-token</code><a class="headerlink" href="#post-request-verify-token" title="Permanent link"></a></h3>
<p>Request a user to verify their e-mail. Will generate a temporary token and call the <code>after_verification_request</code> <a href="../../configuration/routers/verify/#after-verification-request">handler</a> if the user <strong>exists</strong>, <strong>active</strong> and <strong>not already verified</strong>.</p>
<p>To prevent malicious users from guessing existing users in your database, the route will always return a <code>202 Accepted</code> response, even if the user requested does not exist, not active or already verified.</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-verify"><code>POST /verify</code><a class="headerlink" href="#post-verify" title="Permanent link"></a></h3>
<p>Verify a user. Requires the token generated by the <code>/request-verify-token</code> route. Will call the call the <code>after_verification</code> <a href="../../configuration/routers/verify/#after-verification">handler</a> on success.</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>
</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>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">"VERIFY_USER_TOKEN_EXPIRED"</span>
<span class="p">}</span>
</code></pre></div>
</div>
<div class="admonition fail">
<p class="admonition-title"><code>400 Bad Request</code></p>
<p>Bad token, not existing user or not the e-mail currently set for the user.</p>
<div class="highlight"><pre><span></span><code><span class="p">{</span>
<span class="nt">"detail"</span><span class="p">:</span> <span class="s2">"VERIFY_USER_BAD_TOKEN"</span>
<span class="p">}</span>
</code></pre></div>
</div>
<div class="admonition fail">
<p class="admonition-title"><code>400 Bad Request</code></p>
<p>The user is already verified.</p>
<div class="highlight"><pre><span></span><code><span class="p">{</span>
<span class="nt">"detail"</span><span class="p">:</span> <span class="s2">"VERIFY_USER_ALREADY_VERIFIED"</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&amp;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&amp;scopes=a+b&amp;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>
<div class="admonition fail">
<p class="admonition-title"><code>400 Bad Request</code></p>
<p><a href="../configuration/password-validation.md">Password validation</a> failed.</p>
<div class="highlight"><pre><span></span><code><span class="p">{</span>
<span class="nt">"detail"</span><span class="p">:</span> <span class="p">{</span>
<span class="nt">"code"</span><span class="p">:</span> <span class="s2">"UPDATE_USER_INVALID_PASSWORD"</span><span class="p">,</span>
<span class="nt">"reason"</span><span class="p">:</span> <span class="s2">"Password should be at least 3 characters"</span>
<span class="p">}</span>
<span class="p">}</span>
</code></pre></div>
</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>
<div class="admonition fail">
<p class="admonition-title"><code>400 Bad Request</code></p>
<p><a href="../configuration/password-validation.md">Password validation</a> failed.</p>
<div class="highlight"><pre><span></span><code><span class="p">{</span>
<span class="nt">"detail"</span><span class="p">:</span> <span class="p">{</span>
<span class="nt">"code"</span><span class="p">:</span> <span class="s2">"UPDATE_USER_INVALID_PASSWORD"</span><span class="p">,</span>
<span class="nt">"reason"</span><span class="p">:</span> <span class="s2">"Password should be at least 3 characters"</span>
<span class="p">}</span>
<span class="p">}</span>
</code></pre></div>
</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">
<nav aria-label="Footer" class="md-footer__inner md-grid">
<a aria-label="Previous: Flow" class="md-footer__link md-footer__link--prev" href="../flow/" rel="prev">
<div class="md-footer__button md-icon">
<svg viewbox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12z"></path></svg>
</div>
<div class="md-footer__title">
<div class="md-ellipsis">
<span class="md-footer__direction">
Previous
</span>
Flow
</div>
</div>
</a>
<a aria-label="Next: Get current user" class="md-footer__link md-footer__link--next" href="../current-user/" rel="next">
<div class="md-footer__title">
<div class="md-ellipsis">
<span class="md-footer__direction">
Next
</span>
Get current user
</div>
</div>
<div class="md-footer__button md-icon">
<svg viewbox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><path d="M4 11v2h12l-5.5 5.5 1.42 1.42L19.84 12l-7.92-7.92L10.5 5.5 16 11H4z"></path></svg>
</div>
</a>
</nav>
<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/" rel="noopener" target="_blank">
Material for MkDocs
</a>
</div>
</div>
</div>
</footer>
</div>
<div class="md-dialog" data-md-component="dialog">
<div class="md-dialog__inner md-typeset"></div>
</div>
<script id="__config" type="application/json">{"base": "../..", "features": [], "translations": {"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", "select.version.title": "Select version"}, "search": "../../assets/javascripts/workers/search.e99e714c.min.js", "version": null}</script>
<script src="../../assets/javascripts/bundle.bc35569b.min.js"></script>
<script src="https://unpkg.com/mermaid/dist/mermaid.min.js"></script>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink