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 Sep 4 16:12:46 UTC 2021 e59fb2c9b9

Browse Source
This commit is contained in:
frankie567
2021-09-04 16:12:46 +00:00
parent 3f1d6edb0c
commit bf0c3ceb26
3 changed files with 3 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -1120,7 +1120,7 @@
<ul>
<li><code>optional</code>: If <code>True</code>, <code>None</code> is returned if there is no authenticated user or if it doesn't pass the other requirements. Otherwise, throw <code>401 Unauthorized</code>. Defaults to <code>False</code>.</li>
<li><code>active</code>: If <code>True</code>, throw <code>401 Unauthorized</code> if the authenticated user is inactive. Defaults to <code>False</code>.</li>
<li><code>verified</code>: If <code>True</code>, throw <code>401 Unauthorized</code> if the authenticated user is not verified. Defaults to <code>False</code>.</li>
<li><code>verified</code>: If <code>True</code>, throw <code>403 Forbidden</code> if the authenticated user is not verified. Defaults to <code>False</code>.</li>
<li><code>superuser</code>: If <code>True</code>, throw <code>403 Forbidden</code> if the authenticated user is not a superuser. Defaults to <code>False</code>.</li>
</ul>
<h3 id="examples">Examples<a class="headerlink" href="#examples" title="Permanent link">&para;</a></h3>
@@ -1171,7 +1171,7 @@
<span class="k">return</span> <span class="sa">f</span><span class="s2">&quot;Hello, </span><span class="si">{</span><span class="n">user</span><span class="o">.</span><span class="n">email</span><span class="si">}</span><span class="s2">&quot;</span>
</code></pre></div>
<h3 id="get_current_verified_user"><code>get_current_verified_user</code><a class="headerlink" href="#get_current_verified_user" title="Permanent link">&para;</a></h3>
<p>Get the current active and verified user. Will throw a <code>401 Unauthorized</code> if missing or wrong credentials or if the user is not active and verified.</p>
<p>Get the current active and verified user. Will throw a <code>401 Unauthorized</code> if missing or wrong credentials or if the user is not active. Will throw a <code>403 Forbidden</code> if the user is unverified.</p>
<div class="highlight"><pre><span></span><code><span class="nd">@app</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">&quot;/protected-route&quot;</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">protected_route</span><span class="p">(</span><span class="n">user</span><span class="p">:</span> <span class="n">User</span> <span class="o">=</span> <span class="n">Depends</span><span class="p">(</span><span class="n">fastapi_users</span><span class="o">.</span><span class="n">get_current_verified_user</span><span class="p">)):</span>
<span class="k">return</span> <span class="sa">f</span><span class="s2">&quot;Hello, </span><span class="si">{</span><span class="n">user</span><span class="o">.</span><span class="n">email</span><span class="si">}</span><span class="s2">&quot;</span>