This commit is contained in:
@@ -1002,9 +1002,8 @@
|
||||
|
||||
<div class="doc doc-contents first">
|
||||
|
||||
<p>Authentication and authorization exceptions.</p>
|
||||
<hr />
|
||||
<h4 id="jwtlib.exceptions--summary">Summary</h4>
|
||||
<h3 id="jwtlib.exceptions--summary">Summary</h3>
|
||||
<p>Authentication and authorization exceptions.</p>
|
||||
<p>This module defines the exception hierarchy used throughout the
|
||||
authentication library to represent authentication, authorization,
|
||||
and service-level failures.</p>
|
||||
@@ -1046,8 +1045,12 @@ selectively.</p>
|
||||
<summary>Notes</summary>
|
||||
<p><strong>Guarantees:</strong></p>
|
||||
<div class="language-text highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span>
|
||||
<span class="normal">2</span></pre></div></td><td class="code"><div><pre><span></span><code>- All authentication-related exceptions raised by this library inherit from this class
|
||||
- Consumers may catch this exception to handle all auth failures uniformly
|
||||
<span class="normal">2</span>
|
||||
<span class="normal">3</span>
|
||||
<span class="normal">4</span></pre></div></td><td class="code"><div><pre><span></span><code>- All authentication-related exceptions raised by this library
|
||||
inherit from this class.
|
||||
- Consumers may catch this exception to handle all auth failures
|
||||
uniformly.
|
||||
</code></pre></div></td></tr></table></div>
|
||||
</details>
|
||||
|
||||
@@ -1068,7 +1071,7 @@ selectively.</p>
|
||||
|
||||
<div class="doc doc-contents ">
|
||||
<p class="doc doc-class-bases">
|
||||
Bases: <code><a class="autorefs autorefs-internal" title="jwtlib.exceptions.AuthError" href="../jwtlib/exceptions/#jwtlib.exceptions.AuthError">AuthError</a></code></p>
|
||||
Bases: <code><a class="autorefs autorefs-internal" title="jwtlib.exceptions.AuthError" href="#jwtlib.exceptions.AuthError">AuthError</a></code></p>
|
||||
|
||||
|
||||
<p>Raised when the authentication service cannot be reached.</p>
|
||||
@@ -1077,7 +1080,9 @@ selectively.</p>
|
||||
<details class="notes" open>
|
||||
<summary>Notes</summary>
|
||||
<p><strong>Guarantees:</strong></p>
|
||||
<div class="language-text highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span></pre></div></td><td class="code"><div><pre><span></span><code>- Indicates a network failure, timeout, or unexpected error while communicating with the auth service
|
||||
<div class="language-text highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span>
|
||||
<span class="normal">2</span></pre></div></td><td class="code"><div><pre><span></span><code>- Indicates a network failure, timeout, or unexpected error while
|
||||
communicating with the auth service.
|
||||
</code></pre></div></td></tr></table></div>
|
||||
</details>
|
||||
|
||||
@@ -1098,16 +1103,19 @@ selectively.</p>
|
||||
|
||||
<div class="doc doc-contents ">
|
||||
<p class="doc doc-class-bases">
|
||||
Bases: <code><a class="autorefs autorefs-internal" title="jwtlib.exceptions.AuthError" href="../jwtlib/exceptions/#jwtlib.exceptions.AuthError">AuthError</a></code></p>
|
||||
Bases: <code><a class="autorefs autorefs-internal" title="jwtlib.exceptions.AuthError" href="#jwtlib.exceptions.AuthError">AuthError</a></code></p>
|
||||
|
||||
|
||||
<p>Raised when the Authorization header is missing or incorrectly formatted.</p>
|
||||
<p>Raised when the <code>Authorization</code> header is missing or incorrectly
|
||||
formatted.</p>
|
||||
|
||||
|
||||
<details class="notes" open>
|
||||
<summary>Notes</summary>
|
||||
<p><strong>Guarantees:</strong></p>
|
||||
<div class="language-text highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span></pre></div></td><td class="code"><div><pre><span></span><code>- Indicates that the header is not present or does not follow the expected `Bearer <token>` format
|
||||
<div class="language-text highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span>
|
||||
<span class="normal">2</span></pre></div></td><td class="code"><div><pre><span></span><code>- Indicates that the header is not present or does not follow the
|
||||
expected `Bearer <token>` format.
|
||||
</code></pre></div></td></tr></table></div>
|
||||
</details>
|
||||
|
||||
@@ -1128,16 +1136,18 @@ selectively.</p>
|
||||
|
||||
<div class="doc doc-contents ">
|
||||
<p class="doc doc-class-bases">
|
||||
Bases: <code><a class="autorefs autorefs-internal" title="jwtlib.exceptions.AuthError" href="../jwtlib/exceptions/#jwtlib.exceptions.AuthError">AuthError</a></code></p>
|
||||
Bases: <code><a class="autorefs autorefs-internal" title="jwtlib.exceptions.AuthError" href="#jwtlib.exceptions.AuthError">AuthError</a></code></p>
|
||||
|
||||
|
||||
<p>Raised when a JWT is missing, malformed, expired, or invalid.</p>
|
||||
<p>Raised when a <code>JWT</code> is missing, malformed, expired, or invalid.</p>
|
||||
|
||||
|
||||
<details class="notes" open>
|
||||
<summary>Notes</summary>
|
||||
<p><strong>Guarantees:</strong></p>
|
||||
<div class="language-text highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span></pre></div></td><td class="code"><div><pre><span></span><code>- This error indicates that the provided token cannot be used to authenticate a request
|
||||
<div class="language-text highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span>
|
||||
<span class="normal">2</span></pre></div></td><td class="code"><div><pre><span></span><code>- This error indicates that the provided token cannot be used to
|
||||
authenticate a request.
|
||||
</code></pre></div></td></tr></table></div>
|
||||
</details>
|
||||
|
||||
@@ -1158,7 +1168,7 @@ selectively.</p>
|
||||
|
||||
<div class="doc doc-contents ">
|
||||
<p class="doc doc-class-bases">
|
||||
Bases: <code><a class="autorefs autorefs-internal" title="jwtlib.exceptions.AuthError" href="../jwtlib/exceptions/#jwtlib.exceptions.AuthError">AuthError</a></code></p>
|
||||
Bases: <code><a class="autorefs autorefs-internal" title="jwtlib.exceptions.AuthError" href="#jwtlib.exceptions.AuthError">AuthError</a></code></p>
|
||||
|
||||
|
||||
<p>Raised when authentication is required but no user context is present.</p>
|
||||
@@ -1167,7 +1177,9 @@ selectively.</p>
|
||||
<details class="notes" open>
|
||||
<summary>Notes</summary>
|
||||
<p><strong>Guarantees:</strong></p>
|
||||
<div class="language-text highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span></pre></div></td><td class="code"><div><pre><span></span><code>- Typically used when attempting to access a protected operation without an authenticated user
|
||||
<div class="language-text highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span>
|
||||
<span class="normal">2</span></pre></div></td><td class="code"><div><pre><span></span><code>- Typically used when attempting to access a protected operation
|
||||
without an authenticated user.
|
||||
</code></pre></div></td></tr></table></div>
|
||||
</details>
|
||||
|
||||
@@ -1188,7 +1200,7 @@ selectively.</p>
|
||||
|
||||
<div class="doc doc-contents ">
|
||||
<p class="doc doc-class-bases">
|
||||
Bases: <code><a class="autorefs autorefs-internal" title="jwtlib.exceptions.AuthError" href="../jwtlib/exceptions/#jwtlib.exceptions.AuthError">AuthError</a></code></p>
|
||||
Bases: <code><a class="autorefs autorefs-internal" title="jwtlib.exceptions.AuthError" href="#jwtlib.exceptions.AuthError">AuthError</a></code></p>
|
||||
|
||||
|
||||
<p>Raised when a valid token does not map to an existing user.</p>
|
||||
@@ -1197,7 +1209,9 @@ selectively.</p>
|
||||
<details class="notes" open>
|
||||
<summary>Notes</summary>
|
||||
<p><strong>Guarantees:</strong></p>
|
||||
<div class="language-text highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span></pre></div></td><td class="code"><div><pre><span></span><code>- Indicates that authentication succeeded at the token level, but the associated user record could not be resolved
|
||||
<div class="language-text highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span>
|
||||
<span class="normal">2</span></pre></div></td><td class="code"><div><pre><span></span><code>- Indicates that authentication succeeded at the token level, but
|
||||
the associated user record could not be resolved.
|
||||
</code></pre></div></td></tr></table></div>
|
||||
</details>
|
||||
|
||||
|
||||
Reference in New Issue
Block a user