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: Sat Oct 16 07:26:51 UTC 2021 843b197875

Browse Source
This commit is contained in:
frankie567
2021-10-16 07:26:51 +00:00
parent d149530967
commit 38110aba25
44 changed files with 200 additions and 200 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
usage/current-user/index.html
View File

@@ -7,9 +7,9 @@
<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"/>
<meta content="mkdocs-1.2.3, mkdocs-material-7.3.3" name="generator"/>
<title>Get current user - FastAPI Users</title>
<link href="../../assets/stylesheets/main.24c991ad.min.css" rel="stylesheet"/>
<link href="../../assets/stylesheets/main.5143246d.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"/>
@@ -630,8 +630,8 @@
<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 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.8397ff9e.min.js", "version": null}</script>
<script src="../../assets/javascripts/bundle.f89c2efe.min.js"></script>
<script src="https://unpkg.com/mermaid/dist/mermaid.min.js"></script>
</body>
</html>

8
usage/flow/index.html
View File

@@ -7,9 +7,9 @@
<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"/>
<meta content="mkdocs-1.2.3, mkdocs-material-7.3.3" name="generator"/>
<title>Flow - FastAPI Users</title>
<link href="../../assets/stylesheets/main.24c991ad.min.css" rel="stylesheet"/>
<link href="../../assets/stylesheets/main.5143246d.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"/>
@@ -1177,8 +1177,8 @@ http://localhost:8000/auth/cookie/logout
<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 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.8397ff9e.min.js", "version": null}</script>
<script src="../../assets/javascripts/bundle.f89c2efe.min.js"></script>
<script src="https://unpkg.com/mermaid/dist/mermaid.min.js"></script>
</body>
</html>

16
usage/routes/index.html
View File

@@ -7,9 +7,9 @@
<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"/>
<meta content="mkdocs-1.2.3, mkdocs-material-7.3.3" name="generator"/>
<title>Routes - FastAPI Users</title>
<link href="../../assets/stylesheets/main.24c991ad.min.css" rel="stylesheet"/>
<link href="../../assets/stylesheets/main.5143246d.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"/>
@@ -696,7 +696,7 @@
</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>
<p>Register a new user. Will call the <code>on_after_register</code> <a href="../../configuration/user-manager/#on_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>
@@ -739,7 +739,7 @@
</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>Request a reset password procedure. Will generate a temporary token and call the <code>on_after_forgot_password</code> <a href="../../configuration/user-manager/#on_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>
@@ -788,7 +788,7 @@
</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>Request a user to verify their e-mail. Will generate a temporary token and call the <code>on_after_request_verify</code> <a href="../../configuration/user-manager/#on_after_request_verify">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>
@@ -801,7 +801,7 @@
<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>
<p>Verify a user. Requires the token generated by the <code>/request-verify-token</code> route. Will call the call the <code>on_after_verify</code> <a href="../../configuration/user-manager/#on_after_verify">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>
@@ -1080,8 +1080,8 @@
<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 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.8397ff9e.min.js", "version": null}</script>
<script src="../../assets/javascripts/bundle.f89c2efe.min.js"></script>
<script src="https://unpkg.com/mermaid/dist/mermaid.min.js"></script>
</body>
</html>