chore: collect auth-server wiki and lib refresh
Picks up the rewritten auth-server wiki (platform anatomy theme) and the regenerated lib artifacts, including the new pep-typed marker bounce.
This commit is contained in:
@@ -434,7 +434,7 @@
|
||||
<li class="md-nav__item">
|
||||
<a href="#register-a-user" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
Register a user
|
||||
👤 Register a user
|
||||
</span>
|
||||
</a>
|
||||
|
||||
@@ -443,7 +443,7 @@
|
||||
<li class="md-nav__item">
|
||||
<a href="#log-in-to-get-a-token" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
Log in to get a token
|
||||
🔑 Log in to get a token
|
||||
</span>
|
||||
</a>
|
||||
|
||||
@@ -452,7 +452,7 @@
|
||||
<li class="md-nav__item">
|
||||
<a href="#call-a-protected-endpoint" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
Call a protected endpoint
|
||||
🔒 Call a protected endpoint
|
||||
</span>
|
||||
</a>
|
||||
|
||||
@@ -461,7 +461,7 @@
|
||||
<li class="md-nav__item">
|
||||
<a href="#log-out" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
Log out
|
||||
🚪 Log out
|
||||
</span>
|
||||
</a>
|
||||
|
||||
@@ -470,7 +470,16 @@
|
||||
<li class="md-nav__item">
|
||||
<a href="#token-lifecycle-quick-reference" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
Token lifecycle quick reference
|
||||
🧭 Token lifecycle quick reference
|
||||
</span>
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#read-next" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
📚 Read Next
|
||||
</span>
|
||||
</a>
|
||||
|
||||
@@ -566,10 +575,11 @@
|
||||
|
||||
|
||||
|
||||
<h1 id="how-to-use">How to Use</h1>
|
||||
<h1 id="how-to-use">🖥️ How to Use</h1>
|
||||
<p>This page covers the plain HTTP usage of the auth server: creating users,
|
||||
logging in, and calling protected endpoints with a bearer token.</p>
|
||||
<h2 id="register-a-user">Register a user</h2>
|
||||
<hr />
|
||||
<h2 id="register-a-user">👤 Register a user</h2>
|
||||
<div class="language-bash highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-1">1</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-2">2</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-3">3</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-0-1"><a id="__codelineno-0-1" name="__codelineno-0-1"></a>curl<span class="w"> </span>-X<span class="w"> </span>POST<span class="w"> </span>http://localhost:8000/register<span class="w"> </span><span class="se">\</span>
|
||||
@@ -593,7 +603,8 @@ logging in, and calling protected endpoints with a bearer token.</p>
|
||||
</span><span id="__span-1-5"><a id="__codelineno-1-5" name="__codelineno-1-5"></a><span class="p">}</span>
|
||||
</span></code></pre></div></td></tr></table></div>
|
||||
<p>The password is never returned.</p>
|
||||
<h2 id="log-in-to-get-a-token">Log in to get a token</h2>
|
||||
<hr />
|
||||
<h2 id="log-in-to-get-a-token">🔑 Log in to get a token</h2>
|
||||
<div class="language-bash highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-2-1">1</a></span>
|
||||
<span class="normal"><a href="#__codelineno-2-2">2</a></span>
|
||||
<span class="normal"><a href="#__codelineno-2-3">3</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-2-1"><a id="__codelineno-2-1" name="__codelineno-2-1"></a>curl<span class="w"> </span>-X<span class="w"> </span>POST<span class="w"> </span>http://localhost:8000/login<span class="w"> </span><span class="se">\</span>
|
||||
@@ -618,7 +629,8 @@ logging in, and calling protected endpoints with a bearer token.</p>
|
||||
</span><span id="__span-3-8"><a id="__codelineno-3-8" name="__codelineno-3-8"></a><span class="p">}</span>
|
||||
</span></code></pre></div></td></tr></table></div>
|
||||
<p>Invalid credentials return <code>401</code> with <code>{"detail": "Invalid credentials"}</code>.</p>
|
||||
<h2 id="call-a-protected-endpoint">Call a protected endpoint</h2>
|
||||
<hr />
|
||||
<h2 id="call-a-protected-endpoint">🔒 Call a protected endpoint</h2>
|
||||
<p>Send the token as a bearer token:</p>
|
||||
<div class="language-bash highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-4-1">1</a></span>
|
||||
<span class="normal"><a href="#__codelineno-4-2">2</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-4-1"><a id="__codelineno-4-1" name="__codelineno-4-1"></a>curl<span class="w"> </span>http://localhost:8000/me<span class="w"> </span><span class="se">\</span>
|
||||
@@ -626,7 +638,8 @@ logging in, and calling protected endpoints with a bearer token.</p>
|
||||
</span></code></pre></div></td></tr></table></div>
|
||||
<p>Response <code>200 OK</code> with the current user profile. A missing or invalid token
|
||||
returns <code>401</code> with <code>WWW-Authenticate: Bearer</code>.</p>
|
||||
<h2 id="log-out">Log out</h2>
|
||||
<hr />
|
||||
<h2 id="log-out">🚪 Log out</h2>
|
||||
<div class="language-bash highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-5-1">1</a></span>
|
||||
<span class="normal"><a href="#__codelineno-5-2">2</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-5-1"><a id="__codelineno-5-1" name="__codelineno-5-1"></a>curl<span class="w"> </span>-X<span class="w"> </span>POST<span class="w"> </span>http://localhost:8000/logout<span class="w"> </span><span class="se">\</span>
|
||||
</span><span id="__span-5-2"><a id="__codelineno-5-2" name="__codelineno-5-2"></a><span class="w"> </span>-H<span class="w"> </span><span class="s2">"Authorization: Bearer <jwt>"</span>
|
||||
@@ -635,7 +648,8 @@ returns <code>401</code> with <code>WWW-Authenticate: Bearer</code>.</p>
|
||||
discard the token:</p>
|
||||
<div class="language-json highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-6-1">1</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-6-1"><a id="__codelineno-6-1" name="__codelineno-6-1"></a><span class="p">{</span><span class="w"> </span><span class="nt">"message"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Successfully logged out. Please discard your token on the client."</span><span class="w"> </span><span class="p">}</span>
|
||||
</span></code></pre></div></td></tr></table></div>
|
||||
<h2 id="token-lifecycle-quick-reference">Token lifecycle quick reference</h2>
|
||||
<hr />
|
||||
<h2 id="token-lifecycle-quick-reference">🧭 Token lifecycle quick reference</h2>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
@@ -675,6 +689,11 @@ discard the token:</p>
|
||||
<p>Interactive examples are available in the <strong>API Reference</strong> site (Swagger UI),
|
||||
rendered from <code>docs/api/openapi.json</code>.</p>
|
||||
<hr />
|
||||
<h2 id="read-next">📚 Read Next</h2>
|
||||
<ul>
|
||||
<li><a href="../01_centralized_auth/">Centralized Auth</a> — the identity model and token contract.</li>
|
||||
<li><a href="../03_platform_integration/">Platform Integration</a> — consuming the token in services.</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
Reference in New Issue
Block a user