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

Automated deployment: Mon May 17 06:59:18 UTC 2021 5267e605f4

Browse Source
This commit is contained in:
frankie567
2021-05-17 06:59:18 +00:00
parent 5eae833fae
commit 615110bb70
32 changed files with 1396 additions and 88 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
404.html
View File

@@ -518,7 +518,19 @@
<li class="md-nav__item">
<a href="/configuration/full_example/" class="md-nav__link">
<a href="/configuration/password-validation/" class="md-nav__link">
Password validation
</a>
</li>
<li class="md-nav__item">
<a href="/configuration/full-example/" class="md-nav__link">
Full example
</a>
</li>

14
configuration/authentication/cookie/index.html
View File

@@ -595,7 +595,19 @@
<li class="md-nav__item">
<a href="../../full_example/" class="md-nav__link">
<a href="../../password-validation/" class="md-nav__link">
Password validation
</a>
</li>
<li class="md-nav__item">
<a href="../../full-example/" class="md-nav__link">
Full example
</a>
</li>

14
configuration/authentication/index.html
View File

@@ -574,7 +574,19 @@
<li class="md-nav__item">
<a href="../full_example/" class="md-nav__link">
<a href="../password-validation/" class="md-nav__link">
Password validation
</a>
</li>
<li class="md-nav__item">
<a href="../full-example/" class="md-nav__link">
Full example
</a>
</li>

14
configuration/authentication/jwt/index.html
View File

@@ -602,7 +602,19 @@
<li class="md-nav__item">
<a href="../../full_example/" class="md-nav__link">
<a href="../../password-validation/" class="md-nav__link">
Password validation
</a>
</li>
<li class="md-nav__item">
<a href="../../full-example/" class="md-nav__link">
Full example
</a>
</li>

14
configuration/databases/mongodb/index.html
View File

@@ -581,7 +581,19 @@
<li class="md-nav__item">
<a href="../../full_example/" class="md-nav__link">
<a href="../../password-validation/" class="md-nav__link">
Password validation
</a>
</li>
<li class="md-nav__item">
<a href="../../full-example/" class="md-nav__link">
Full example
</a>
</li>

14
configuration/databases/ormar/index.html
View File

@@ -588,7 +588,19 @@
<li class="md-nav__item">
<a href="../../full_example/" class="md-nav__link">
<a href="../../password-validation/" class="md-nav__link">
Password validation
</a>
</li>
<li class="md-nav__item">
<a href="../../full-example/" class="md-nav__link">
Full example
</a>
</li>

14
configuration/databases/sqlalchemy/index.html
View File

@@ -602,7 +602,19 @@
<li class="md-nav__item">
<a href="../../full_example/" class="md-nav__link">
<a href="../../password-validation/" class="md-nav__link">
Password validation
</a>
</li>
<li class="md-nav__item">
<a href="../../full-example/" class="md-nav__link">
Full example
</a>
</li>

14
configuration/databases/tortoise/index.html
View File

@@ -602,7 +602,19 @@
<li class="md-nav__item">
<a href="../../full_example/" class="md-nav__link">
<a href="../../password-validation/" class="md-nav__link">
Password validation
</a>
</li>
<li class="md-nav__item">
<a href="../../full-example/" class="md-nav__link">
Full example
</a>
</li>

16
configuration/full_example/index.html → configuration/full-example/index.html
View File

@@ -523,6 +523,18 @@
<li class="md-nav__item">
<a href="../password-validation/" class="md-nav__link">
Password validation
</a>
</li>
@@ -1268,7 +1280,7 @@ Insecure passwords may give attackers full access to your database.</p>
<nav class="md-footer__inner md-grid" aria-label="Footer">
<a href="../routers/verify/" class="md-footer__link md-footer__link--prev" rel="prev">
<a href="../password-validation/" class="md-footer__link md-footer__link--prev" rel="prev">
<div class="md-footer__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>
@@ -1277,7 +1289,7 @@ Insecure passwords may give attackers full access to your database.</p>
<span class="md-footer__direction">
Previous
</span>
Verify router
Password validation
</div>
</div>
</a>

41
configuration/model/index.html
View File

@@ -313,13 +313,6 @@
Define your models
</a>
</li>
<li class="md-nav__item">
<a href="#password-validation" class="md-nav__link">
Password validation
</a>
</li>
<li class="md-nav__item">
@@ -579,7 +572,19 @@
<li class="md-nav__item">
<a href="../full_example/" class="md-nav__link">
<a href="../password-validation/" class="md-nav__link">
Password validation
</a>
</li>
<li class="md-nav__item">
<a href="../full-example/" class="md-nav__link">
Full example
</a>
</li>
@@ -802,13 +807,6 @@
Define your models
</a>
</li>
<li class="md-nav__item">
<a href="#password-validation" class="md-nav__link">
Password validation
</a>
</li>
<li class="md-nav__item">
@@ -868,19 +866,6 @@
<span class="k">pass</span>
</code></pre></div>
<p>You can of course add your own properties there to fit to your needs!</p>
<h2 id="password-validation">Password validation<a class="headerlink" href="#password-validation" title="Permanent link">&para;</a></h2>
<p><strong>FastAPI Users</strong> doesn't provide a default password validation, but you can implement it easily with a <a href="https://pydantic-docs.helpmanual.io/usage/validators/">Pydantic validator</a> on the <code>UserCreate</code> class. Here is a simple example to check if the password is at least six characters long:</p>
<div class="highlight"><pre><span></span><code><span class="kn">from</span> <span class="nn">fastapi_users</span> <span class="kn">import</span> <span class="n">models</span>
<span class="kn">from</span> <span class="nn">pydantic</span> <span class="kn">import</span> <span class="n">validator</span>
<span class="k">class</span> <span class="nc">UserCreate</span><span class="p">(</span><span class="n">models</span><span class="o">.</span><span class="n">BaseUserCreate</span><span class="p">):</span>
<span class="nd">@validator</span><span class="p">(</span><span class="s1">&#39;password&#39;</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">valid_password</span><span class="p">(</span><span class="bp">cls</span><span class="p">,</span> <span class="n">v</span><span class="p">:</span> <span class="nb">str</span><span class="p">):</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">v</span><span class="p">)</span> <span class="o">&lt;</span> <span class="mi">6</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s1">&#39;Password should be at least 6 characters&#39;</span><span class="p">)</span>
<span class="k">return</span> <span class="n">v</span>
</code></pre></div>
<h2 id="next-steps">Next steps<a class="headerlink" href="#next-steps" title="Permanent link">&para;</a></h2>
<p>Depending on your database backend, the database configuration will differ a bit.</p>
<p><a href="../databases/sqlalchemy/">I'm using SQLAlchemy</a></p>

16
configuration/oauth/index.html
View File

@@ -525,7 +525,19 @@
<li class="md-nav__item">
<a href="../full_example/" class="md-nav__link">
<a href="../password-validation/" class="md-nav__link">
Password validation
</a>
</li>
<li class="md-nav__item">
<a href="../full-example/" class="md-nav__link">
Full example
</a>
</li>
@@ -1481,7 +1493,7 @@ Insecure passwords may give attackers full access to your database.</p>
<nav class="md-footer__inner md-grid" aria-label="Footer">
<a href="../full_example/" class="md-footer__link md-footer__link--prev" rel="prev">
<a href="../full-example/" class="md-footer__link md-footer__link--prev" rel="prev">
<div class="md-footer__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>

950
configuration/password-validation/index.html Normal file
View File

@@ -0,0 +1,950 @@
<!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="icon" href="../../favicon.png">
<meta name="generator" content="mkdocs-1.1.2, mkdocs-material-7.1.4">
<title>Password validation - FastAPI Users</title>
<link rel="stylesheet" href="../../assets/stylesheets/main.bde7dde4.min.css">
<link rel="stylesheet" href="../../assets/stylesheets/palette.ef6f36e2.min.css">
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,400,400i,700%7CRoboto+Mono&display=fallback">
<style>:root{--md-text-font-family:"Roboto";--md-code-font-family:"Roboto Mono"}</style>
</head>
<body dir="ltr" data-md-color-scheme="default" data-md-color-primary="red" data-md-color-accent="red">
<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 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="#password-validation" 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__inner md-grid" aria-label="Header">
<a href="../.." title="FastAPI Users" class="md-header__button md-logo" aria-label="FastAPI Users" data-md-component="logo">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><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"/></svg>
</a>
<label class="md-header__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__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">
Password validation
</span>
</div>
</div>
</div>
<form class="md-header__option" data-md-component="palette">
<input class="md-option" data-md-color-media="" data-md-color-scheme="default" data-md-color-primary="red" data-md-color-accent="red" type="radio" name="__palette" id="__palette_1">
<label class="md-header__button md-icon" title="Switch to dark mode" for="__palette_2" hidden>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><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"/></svg>
</label>
<input class="md-option" data-md-color-media="" data-md-color-scheme="slate" data-md-color-primary="red" data-md-color-accent="red" type="radio" name="__palette" id="__palette_2">
<label class="md-header__button md-icon" title="Switch to light mode" for="__palette_1" hidden>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><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"/></svg>
</label>
</form>
<label class="md-header__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 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"/></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 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"/></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" tabindex="-1">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><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"/></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__source">
<a href="https://github.com/frankie567/fastapi-users" title="Go to repository" class="md-source" data-md-component="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.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"/></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 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" data-md-component="logo">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><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"/></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" data-md-component="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.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"/></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--active md-nav__item--nested">
<input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3" type="checkbox" id="__nav_3" checked>
<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="../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="../databases/sqlalchemy/" class="md-nav__link">
SQLAlchemy
</a>
</li>
<li class="md-nav__item">
<a href="../databases/mongodb/" class="md-nav__link">
MongoDB
</a>
</li>
<li class="md-nav__item">
<a href="../databases/tortoise/" class="md-nav__link">
Tortoise ORM
</a>
</li>
<li class="md-nav__item">
<a href="../databases/ormar/" class="md-nav__link">
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_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="../authentication/" class="md-nav__link">
Introduction
</a>
</li>
<li class="md-nav__item">
<a href="../authentication/jwt/" class="md-nav__link">
JWT
</a>
</li>
<li class="md-nav__item">
<a href="../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="../routers/" class="md-nav__link">
Introduction
</a>
</li>
<li class="md-nav__item">
<a href="../routers/auth/" class="md-nav__link">
Auth router
</a>
</li>
<li class="md-nav__item">
<a href="../routers/register/" class="md-nav__link">
Register routes
</a>
</li>
<li class="md-nav__item">
<a href="../routers/reset/" class="md-nav__link">
Reset password router
</a>
</li>
<li class="md-nav__item">
<a href="../routers/users/" class="md-nav__link">
Users router
</a>
</li>
<li class="md-nav__item">
<a href="../routers/verify/" class="md-nav__link">
Verify router
</a>
</li>
</ul>
</nav>
</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">
Password validation
<span class="md-nav__icon md-icon"></span>
</label>
<a href="./" class="md-nav__link md-nav__link--active">
Password validation
</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-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#configuration" class="md-nav__link">
Configuration
</a>
</li>
<li class="md-nav__item">
<a href="#example" class="md-nav__link">
Example
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="../full-example/" class="md-nav__link">
Full example
</a>
</li>
<li class="md-nav__item">
<a href="../oauth/" class="md-nav__link">
OAuth2
</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_4" type="checkbox" id="__nav_4" >
<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="../../usage/flow/" class="md-nav__link">
Flow
</a>
</li>
<li class="md-nav__item">
<a href="../../usage/routes/" class="md-nav__link">
Routes
</a>
</li>
<li class="md-nav__item">
<a href="../../usage/dependency-callables/" class="md-nav__link">
Dependency callables
</a>
</li>
<li class="md-nav__item">
<a href="../../usage/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>
<li class="md-nav__item">
<a href="../../migration/3x_to_4x/" class="md-nav__link">
3.x.x ➡️ 4.x.x
</a>
</li>
<li class="md-nav__item">
<a href="../../migration/4x_to_5x/" class="md-nav__link">
4.x.x ➡️ 5.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 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-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#configuration" class="md-nav__link">
Configuration
</a>
</li>
<li class="md-nav__item">
<a href="#example" class="md-nav__link">
Example
</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-content" data-md-component="content">
<article class="md-content__inner md-typeset">
<h1 id="password-validation">Password validation<a class="headerlink" href="#password-validation" title="Permanent link">&para;</a></h1>
<p>FastAPI Users <strong>doesn't have any password validation logic by default</strong>. However, there is an argument on the <code>FastAPIUsers</code> class so that you can provide your own password validation function.</p>
<p>It'll be applied on each routes that need to validate the input password:</p>
<ul>
<li>At registration (<a href="../../usage/routes/#post-register"><code>/register</code></a>)</li>
<li>At password reset (<a href="../../usage/routes/#post-reset-password"><code>/reset-password</code></a>)</li>
<li>At profile update (<a href="../../usage/routes/#patch-me"><code>/me</code></a> and <a href="../../usage/routes/#patch-user_id"><code>/{user_id}</code></a>)</li>
</ul>
<h2 id="configuration">Configuration<a class="headerlink" href="#configuration" title="Permanent link">&para;</a></h2>
<p>The FastAPIUsers class accepts an optional keyword argument <code>validate_password</code>. It expects an async function which accepts in argument:</p>
<ul>
<li><code>password</code> (<code>str</code>): the password to validate.</li>
<li><code>user</code> (<code>Union[UserRegister, User]</code>): user model which we are currently validating the password. Useful if you want to check that the password doesn't contain the name or the birthdate of the user for example.</li>
</ul>
<p>This function should return <code>None</code> if the password is valid or raise <code>InvalidPasswordException</code> if not. This exception expects an argument <code>reason</code> telling why the password is invalid. It'll be part of the error response.</p>
<h2 id="example">Example<a class="headerlink" href="#example" title="Permanent link">&para;</a></h2>
<div class="highlight"><pre><span></span><code><span class="kn">from</span> <span class="nn">fastapi_users</span> <span class="kn">import</span> <span class="n">FastAPIUsers</span><span class="p">,</span> <span class="n">InvalidPasswordException</span>
<span class="k">async</span> <span class="k">def</span> <span class="nf">validate_password</span><span class="p">(</span>
<span class="n">password</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
<span class="n">user</span><span class="p">:</span> <span class="n">Union</span><span class="p">[</span><span class="n">UserRegister</span><span class="p">,</span> <span class="n">User</span><span class="p">]],</span>
<span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">password</span><span class="p">)</span> <span class="o">&lt;</span> <span class="mi">8</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">InvalidPasswordException</span><span class="p">(</span>
<span class="n">reason</span><span class="o">=</span><span class="s2">&quot;Password should be at least 8 characters&quot;</span>
<span class="p">)</span>
<span class="k">if</span> <span class="n">user</span><span class="o">.</span><span class="n">email</span> <span class="ow">in</span> <span class="n">password</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">InvalidPasswordException</span><span class="p">(</span>
<span class="n">reason</span><span class="o">=</span><span class="s2">&quot;Password should not contain e-mail&quot;</span>
<span class="p">)</span>
<span class="n">fastapi_users</span> <span class="o">=</span> <span class="n">FastAPIUsers</span><span class="p">(</span>
<span class="n">user_db</span><span class="p">,</span>
<span class="p">[</span><span class="n">jwt_authentication</span><span class="p">],</span>
<span class="n">User</span><span class="p">,</span>
<span class="n">UserCreate</span><span class="p">,</span>
<span class="n">UserUpdate</span><span class="p">,</span>
<span class="n">UserDB</span><span class="p">,</span>
<span class="n">validate_password</span><span class="o">=</span><span class="n">validate_password</span>
<span class="p">)</span>
</code></pre></div>
</article>
</div>
</div>
</main>
<footer class="md-footer">
<nav class="md-footer__inner md-grid" aria-label="Footer">
<a href="../routers/verify/" class="md-footer__link md-footer__link--prev" rel="prev">
<div class="md-footer__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__title">
<div class="md-ellipsis">
<span class="md-footer__direction">
Previous
</span>
Verify router
</div>
</div>
</a>
<a href="../full-example/" class="md-footer__link md-footer__link--next" rel="next">
<div class="md-footer__title">
<div class="md-ellipsis">
<span class="md-footer__direction">
Next
</span>
Full example
</div>
</div>
<div class="md-footer__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 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>
<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"}, "search": "../../assets/javascripts/workers/search.4fa0e4ee.min.js", "version": null}</script>
<script src="../../assets/javascripts/bundle.1d3bfcf1.min.js"></script>
</body>
</html>

14
configuration/routers/auth/index.html
View File

@@ -580,7 +580,19 @@
<li class="md-nav__item">
<a href="../../full_example/" class="md-nav__link">
<a href="../../password-validation/" class="md-nav__link">
Password validation
</a>
</li>
<li class="md-nav__item">
<a href="../../full-example/" class="md-nav__link">
Full example
</a>
</li>

14
configuration/routers/index.html
View File

@@ -574,7 +574,19 @@
<li class="md-nav__item">
<a href="../full_example/" class="md-nav__link">
<a href="../password-validation/" class="md-nav__link">
Password validation
</a>
</li>
<li class="md-nav__item">
<a href="../full-example/" class="md-nav__link">
Full example
</a>
</li>

14
configuration/routers/register/index.html
View File

@@ -574,7 +574,19 @@
<li class="md-nav__item">
<a href="../../full_example/" class="md-nav__link">
<a href="../../password-validation/" class="md-nav__link">
Password validation
</a>
</li>
<li class="md-nav__item">
<a href="../../full-example/" class="md-nav__link">
Full example
</a>
</li>

14
configuration/routers/reset/index.html
View File

@@ -581,7 +581,19 @@
<li class="md-nav__item">
<a href="../../full_example/" class="md-nav__link">
<a href="../../password-validation/" class="md-nav__link">
Password validation
</a>
</li>
<li class="md-nav__item">
<a href="../../full-example/" class="md-nav__link">
Full example
</a>
</li>

14
configuration/routers/users/index.html
View File

@@ -587,7 +587,19 @@
<li class="md-nav__item">
<a href="../../full_example/" class="md-nav__link">
<a href="../../password-validation/" class="md-nav__link">
Password validation
</a>
</li>
<li class="md-nav__item">
<a href="../../full-example/" class="md-nav__link">
Full example
</a>
</li>

18
configuration/routers/verify/index.html
View File

@@ -581,7 +581,19 @@
<li class="md-nav__item">
<a href="../../full_example/" class="md-nav__link">
<a href="../../password-validation/" class="md-nav__link">
Password validation
</a>
</li>
<li class="md-nav__item">
<a href="../../full-example/" class="md-nav__link">
Full example
</a>
</li>
@@ -936,13 +948,13 @@
</a>
<a href="../../full_example/" class="md-footer__link md-footer__link--next" rel="next">
<a href="../../password-validation/" class="md-footer__link md-footer__link--next" rel="next">
<div class="md-footer__title">
<div class="md-ellipsis">
<span class="md-footer__direction">
Next
</span>
Full example
Password validation
</div>
</div>
<div class="md-footer__button md-icon">

17
index.html
View File

@@ -611,7 +611,19 @@
<li class="md-nav__item">
<a href="configuration/full_example/" class="md-nav__link">
<a href="configuration/password-validation/" class="md-nav__link">
Password validation
</a>
</li>
<li class="md-nav__item">
<a href="configuration/full-example/" class="md-nav__link">
Full example
</a>
</li>
@@ -921,8 +933,9 @@
<ul class="task-list">
<li class="task-list-item"><input type="checkbox" disabled checked/> Extensible base user model</li>
<li class="task-list-item"><input type="checkbox" disabled checked/> Ready-to-use register, login, reset password and verify e-mail routes</li>
<li class="task-list-item"><input type="checkbox" disabled checked/> Ready-to-use OAuth2 flow</li>
<li class="task-list-item"><input type="checkbox" disabled checked/> Ready-to-use social OAuth2 login flow</li>
<li class="task-list-item"><input type="checkbox" disabled checked/> Dependency callables to inject current user in route</li>
<li class="task-list-item"><input type="checkbox" disabled checked/> Pluggable password validation</li>
<li class="task-list-item">
<p><input type="checkbox" disabled checked/> Customizable database backend</p>
<ul class="task-list">

14
installation/index.html
View File

@@ -584,7 +584,19 @@
<li class="md-nav__item">
<a href="../configuration/full_example/" class="md-nav__link">
<a href="../configuration/password-validation/" class="md-nav__link">
Password validation
</a>
</li>
<li class="md-nav__item">
<a href="../configuration/full-example/" class="md-nav__link">
Full example
</a>
</li>

14
migration/08_to_1x/index.html
View File

@@ -523,7 +523,19 @@
<li class="md-nav__item">
<a href="../../configuration/full_example/" class="md-nav__link">
<a href="../../configuration/password-validation/" class="md-nav__link">
Password validation
</a>
</li>
<li class="md-nav__item">
<a href="../../configuration/full-example/" class="md-nav__link">
Full example
</a>
</li>

14
migration/1x_to_2x/index.html
View File

@@ -523,7 +523,19 @@
<li class="md-nav__item">
<a href="../../configuration/full_example/" class="md-nav__link">
<a href="../../configuration/password-validation/" class="md-nav__link">
Password validation
</a>
</li>
<li class="md-nav__item">
<a href="../../configuration/full-example/" class="md-nav__link">
Full example
</a>
</li>

14
migration/2x_to_3x/index.html
View File

@@ -523,7 +523,19 @@
<li class="md-nav__item">
<a href="../../configuration/full_example/" class="md-nav__link">
<a href="../../configuration/password-validation/" class="md-nav__link">
Password validation
</a>
</li>
<li class="md-nav__item">
<a href="../../configuration/full-example/" class="md-nav__link">
Full example
</a>
</li>

14
migration/3x_to_4x/index.html
View File

@@ -523,7 +523,19 @@
<li class="md-nav__item">
<a href="../../configuration/full_example/" class="md-nav__link">
<a href="../../configuration/password-validation/" class="md-nav__link">
Password validation
</a>
</li>
<li class="md-nav__item">
<a href="../../configuration/full-example/" class="md-nav__link">
Full example
</a>
</li>

14
migration/4x_to_5x/index.html
View File

@@ -523,7 +523,19 @@
<li class="md-nav__item">
<a href="../../configuration/full_example/" class="md-nav__link">
<a href="../../configuration/password-validation/" class="md-nav__link">
Password validation
</a>
</li>
<li class="md-nav__item">
<a href="../../configuration/full-example/" class="md-nav__link">
Full example
</a>
</li>

2
search/search_index.json
View File

File diff suppressed because one or more lines are too long

58
sitemap.xml
View File

@@ -1,111 +1,115 @@
<?xml version="1.0" encoding="UTF-8"?>
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9"><url>
<loc>None</loc>
<lastmod>2021-05-13</lastmod>
<lastmod>2021-05-17</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>None</loc>
<lastmod>2021-05-13</lastmod>
<lastmod>2021-05-17</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>None</loc>
<lastmod>2021-05-13</lastmod>
<lastmod>2021-05-17</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>None</loc>
<lastmod>2021-05-13</lastmod>
<lastmod>2021-05-17</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>None</loc>
<lastmod>2021-05-13</lastmod>
<lastmod>2021-05-17</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>None</loc>
<lastmod>2021-05-13</lastmod>
<lastmod>2021-05-17</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>None</loc>
<lastmod>2021-05-13</lastmod>
<lastmod>2021-05-17</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>None</loc>
<lastmod>2021-05-13</lastmod>
<lastmod>2021-05-17</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>None</loc>
<lastmod>2021-05-13</lastmod>
<lastmod>2021-05-17</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>None</loc>
<lastmod>2021-05-13</lastmod>
<lastmod>2021-05-17</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>None</loc>
<lastmod>2021-05-13</lastmod>
<lastmod>2021-05-17</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>None</loc>
<lastmod>2021-05-13</lastmod>
<lastmod>2021-05-17</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>None</loc>
<lastmod>2021-05-13</lastmod>
<lastmod>2021-05-17</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>None</loc>
<lastmod>2021-05-13</lastmod>
<lastmod>2021-05-17</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>None</loc>
<lastmod>2021-05-13</lastmod>
<lastmod>2021-05-17</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>None</loc>
<lastmod>2021-05-13</lastmod>
<lastmod>2021-05-17</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>None</loc>
<lastmod>2021-05-13</lastmod>
<lastmod>2021-05-17</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>None</loc>
<lastmod>2021-05-13</lastmod>
<lastmod>2021-05-17</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>None</loc>
<lastmod>2021-05-13</lastmod>
<lastmod>2021-05-17</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>None</loc>
<lastmod>2021-05-13</lastmod>
<lastmod>2021-05-17</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>None</loc>
<lastmod>2021-05-13</lastmod>
<lastmod>2021-05-17</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>None</loc>
<lastmod>2021-05-13</lastmod>
<lastmod>2021-05-17</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>None</loc>
<lastmod>2021-05-13</lastmod>
<lastmod>2021-05-17</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>None</loc>
<lastmod>2021-05-13</lastmod>
<lastmod>2021-05-17</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>None</loc>
<lastmod>2021-05-13</lastmod>
<lastmod>2021-05-17</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>None</loc>
<lastmod>2021-05-13</lastmod>
<lastmod>2021-05-17</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>None</loc>
<lastmod>2021-05-13</lastmod>
<lastmod>2021-05-17</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>None</loc>
<lastmod>2021-05-17</lastmod>
<changefreq>daily</changefreq>
</url>
</urlset>

BIN
sitemap.xml.gz
View File

Binary file not shown.

14
usage/dependency-callables/index.html
View File

@@ -523,7 +523,19 @@
<li class="md-nav__item">
<a href="../../configuration/full_example/" class="md-nav__link">
<a href="../../configuration/password-validation/" class="md-nav__link">
Password validation
</a>
</li>
<li class="md-nav__item">
<a href="../../configuration/full-example/" class="md-nav__link">
Full example
</a>
</li>

14
usage/flow/index.html
View File

@@ -523,7 +523,19 @@
<li class="md-nav__item">
<a href="../../configuration/full_example/" class="md-nav__link">
<a href="../../configuration/password-validation/" class="md-nav__link">
Password validation
</a>
</li>
<li class="md-nav__item">
<a href="../../configuration/full-example/" class="md-nav__link">
Full example
</a>
</li>

14
usage/helpers/index.html
View File

@@ -523,7 +523,19 @@
<li class="md-nav__item">
<a href="../../configuration/full_example/" class="md-nav__link">
<a href="../../configuration/password-validation/" class="md-nav__link">
Password validation
</a>
</li>
<li class="md-nav__item">
<a href="../../configuration/full-example/" class="md-nav__link">
Full example
</a>
</li>

58
usage/routes/index.html
View File

@@ -523,7 +523,19 @@
<li class="md-nav__item">
<a href="../../configuration/full_example/" class="md-nav__link">
<a href="../../configuration/password-validation/" class="md-nav__link">
Password validation
</a>
</li>
<li class="md-nav__item">
<a href="../../configuration/full-example/" class="md-nav__link">
Full example
</a>
</li>
@@ -1217,6 +1229,17 @@
<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/">Password validation</a> failed.</p>
<div class="highlight"><pre><span></span><code><span class="p">{</span>
<span class="nt">&quot;detail&quot;</span><span class="p">:</span> <span class="p">{</span>
<span class="nt">&quot;code&quot;</span><span class="p">:</span> <span class="s2">&quot;RESET_PASSWORD_INVALID_PASSWORD&quot;</span><span class="p">,</span>
<span class="nt">&quot;reason&quot;</span><span class="p">:</span> <span class="s2">&quot;Password should be at least 3 characters&quot;</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">&para;</a></h2>
<h3 id="post-forgot-password"><code>POST /forgot-password</code><a class="headerlink" href="#post-forgot-password" title="Permanent link">&para;</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>
@@ -1255,6 +1278,17 @@
<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/">Password validation</a> failed.</p>
<div class="highlight"><pre><span></span><code><span class="p">{</span>
<span class="nt">&quot;detail&quot;</span><span class="p">:</span> <span class="p">{</span>
<span class="nt">&quot;code&quot;</span><span class="p">:</span> <span class="s2">&quot;REGISTER_INVALID_PASSWORD&quot;</span><span class="p">,</span>
<span class="nt">&quot;reason&quot;</span><span class="p">:</span> <span class="s2">&quot;Password should be at least 3 characters&quot;</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">&para;</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">&para;</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>
@@ -1402,6 +1436,17 @@
<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/">Password validation</a> failed.</p>
<div class="highlight"><pre><span></span><code><span class="p">{</span>
<span class="nt">&quot;detail&quot;</span><span class="p">:</span> <span class="p">{</span>
<span class="nt">&quot;code&quot;</span><span class="p">:</span> <span class="s2">&quot;UPDATE_USER_INVALID_PASSWORD&quot;</span><span class="p">,</span>
<span class="nt">&quot;reason&quot;</span><span class="p">:</span> <span class="s2">&quot;Password should be at least 3 characters&quot;</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">&para;</a></h3>
<p>Return the user with id <code>user_id</code>.</p>
<div class="admonition success">
@@ -1460,6 +1505,17 @@
<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/">Password validation</a> failed.</p>
<div class="highlight"><pre><span></span><code><span class="p">{</span>
<span class="nt">&quot;detail&quot;</span><span class="p">:</span> <span class="p">{</span>
<span class="nt">&quot;code&quot;</span><span class="p">:</span> <span class="s2">&quot;UPDATE_USER_INVALID_PASSWORD&quot;</span><span class="p">,</span>
<span class="nt">&quot;reason&quot;</span><span class="p">:</span> <span class="s2">&quot;Password should be at least 3 characters&quot;</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">&para;</a></h3>
<p>Delete the user with id <code>user_id</code>.</p>
<div class="admonition success">