aetos/docs
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
24ecde4222337836ce10a47041f70a64c6912e46
docs/libs/py-jwt/site/jwtlib/models/index.html
Vishesh 'ironeagle' Bangotra 24ecde4222
All checks were successful
continuous-integration/drone/push Build is passing
Details
added more libs
2026-01-22 17:20:17 +05:30

1886 lines
39 KiB
HTML
Raw Blame History

<!doctype html>
<html lang="en" class="no-js">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<link rel="prev" href="../introspection/">
<link rel="next" href="app/">
<link rel="icon" href="../../assets/images/favicon.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.23">
<title>Models - jwtlib</title>
<link rel="stylesheet" href="../../assets/stylesheets/main.84d31ad4.min.css">
<link rel="stylesheet" href="../../assets/stylesheets/palette.06af60db.min.css">
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Inter:300,300i,400,400i,700,700i%7CJetBrains+Mono:400,400i,700,700i&display=fallback">
<style>:root{--md-text-font:"Inter";--md-code-font:"JetBrains Mono"}</style>
<link rel="stylesheet" href="../../assets/_mkdocstrings.css">
<script>__md_scope=new URL("../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
</head>
<body dir="ltr" data-md-color-scheme="slate" data-md-color-primary="deep-purple" data-md-color-accent="cyan">
<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="#models" 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="jwtlib" class="md-header__button md-logo" aria-label="jwtlib" data-md-component="logo">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 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 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></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 6h18v2H3zm0 5h18v2H3zm0 5h18v2H3z"/></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">
jwtlib
</span>
</div>
<div class="md-header__topic" data-md-component="header-topic">
<span class="md-ellipsis">
Models
</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="slate" data-md-color-primary="deep-purple" data-md-color-accent="cyan" aria-hidden="true" type="radio" name="__palette" id="__palette_0">
</form>
<script>var palette=__md_get("__palette");if(palette&&palette.color){if("(prefers-color-scheme)"===palette.color.media){var media=matchMedia("(prefers-color-scheme: light)"),input=document.querySelector(media.matches?"[data-md-color-media='(prefers-color-scheme: light)']":"[data-md-color-media='(prefers-color-scheme: dark)']");palette.color.media=input.getAttribute("data-md-color-media"),palette.color.scheme=input.getAttribute("data-md-color-scheme"),palette.color.primary=input.getAttribute("data-md-color-primary"),palette.color.accent=input.getAttribute("data-md-color-accent")}for(var[key,value]of Object.entries(palette.color))document.body.setAttribute("data-md-color-"+key,value)}</script>
<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.52 6.52 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 5"/></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" 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.52 6.52 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 5"/></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 11z"/></svg>
</label>
<nav class="md-search__options" aria-label="Search">
<button type="reset" class="md-search__icon md-icon" title="Clear" 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 12z"/></svg>
</button>
</nav>
</form>
<div class="md-search__output">
<div class="md-search__scrollwrap" tabindex="0" 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" role="presentation"></ol>
</div>
</div>
</div>
</div>
</div>
</nav>
</header>
<div class="md-container" data-md-component="container">
<nav class="md-tabs" aria-label="Tabs" data-md-component="tabs">
<div class="md-grid">
<ul class="md-tabs__list">
<li class="md-tabs__item">
<a href="../" class="md-tabs__link">
Home
</a>
</li>
<li class="md-tabs__item">
<a href="../app/" class="md-tabs__link">
Authentication Logic
</a>
</li>
<li class="md-tabs__item md-tabs__item--active">
<a href="./" class="md-tabs__link">
Data & Models
</a>
</li>
<li class="md-tabs__item">
<a href="../repository/" class="md-tabs__link">
Persistence & Security
</a>
</li>
<li class="md-tabs__item">
<a href="../utils/" class="md-tabs__link">
Support & Utilities
</a>
</li>
</ul>
</div>
</nav>
<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 md-nav--lifted" aria-label="Navigation" data-md-level="0">
<label class="md-nav__title" for="__drawer">
<a href="../.." title="jwtlib" class="md-nav__button md-logo" aria-label="jwtlib" data-md-component="logo">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 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 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
</a>
jwtlib
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../" class="md-nav__link">
<span class="md-ellipsis">
Home
</span>
</a>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2" >
<label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
<span class="md-ellipsis">
Authentication Logic
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_2">
<span class="md-nav__icon md-icon"></span>
Authentication Logic
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../app/" class="md-nav__link">
<span class="md-ellipsis">
App
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../introspection/" class="md-nav__link">
<span class="md-ellipsis">
Introspection
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3" checked>
<label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="">
<span class="md-ellipsis">
Data & Models
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_3">
<span class="md-nav__icon md-icon"></span>
Data & Models
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item md-nav__item--active">
<input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
<label class="md-nav__link md-nav__link--active" for="__toc">
<span class="md-ellipsis">
Models
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<a href="./" class="md-nav__link md-nav__link--active">
<span class="md-ellipsis">
Models
</span>
</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="#jwtlib.models" class="md-nav__link">
<span class="md-ellipsis">
models
</span>
</a>
<nav class="md-nav" aria-label="models">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#jwtlib.models--jwtlib-models-structured-data-for-authentication" class="md-nav__link">
<span class="md-ellipsis">
jwtlib Models: Structured Data for Authentication
</span>
</a>
<nav class="md-nav" aria-label="jwtlib Models: Structured Data for Authentication">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#jwtlib.models--model-categories" class="md-nav__link">
<span class="md-ellipsis">
Model Categories
</span>
</a>
<nav class="md-nav" aria-label="Model Categories">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#jwtlib.models--1-api-requests" class="md-nav__link">
<span class="md-ellipsis">
1. API Requests
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#jwtlib.models--2-api-responses" class="md-nav__link">
<span class="md-ellipsis">
2. API Responses
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#jwtlib.models--3-internal-security" class="md-nav__link">
<span class="md-ellipsis">
3. Internal &amp; Security
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#jwtlib.models--usage-patterns" class="md-nav__link">
<span class="md-ellipsis">
Usage Patterns
</span>
</a>
<nav class="md-nav" aria-label="Usage Patterns">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#jwtlib.models--validating-an-auth-request" class="md-nav__link">
<span class="md-ellipsis">
Validating an Auth Request
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#jwtlib.models--projecting-a-user-to-public-view" class="md-nav__link">
<span class="md-ellipsis">
Projecting a User to Public View
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#jwtlib.models.IntrospectRequest" class="md-nav__link">
<span class="md-ellipsis">
IntrospectRequest
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#jwtlib.models.IntrospectResponse" class="md-nav__link">
<span class="md-ellipsis">
IntrospectResponse
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#jwtlib.models.LoginRequest" class="md-nav__link">
<span class="md-ellipsis">
LoginRequest
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#jwtlib.models.LoginResponse" class="md-nav__link">
<span class="md-ellipsis">
LoginResponse
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#jwtlib.models.LogoutResponse" class="md-nav__link">
<span class="md-ellipsis">
LogoutResponse
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#jwtlib.models.PublicUser" class="md-nav__link">
<span class="md-ellipsis">
PublicUser
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#jwtlib.models.RegisterRequest" class="md-nav__link">
<span class="md-ellipsis">
RegisterRequest
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#jwtlib.models.TokenPayload" class="md-nav__link">
<span class="md-ellipsis">
TokenPayload
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#jwtlib.models.User" class="md-nav__link">
<span class="md-ellipsis">
User
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="app/" class="md-nav__link">
<span class="md-ellipsis">
App
</span>
</a>
</li>
<li class="md-nav__item">
<a href="security/" class="md-nav__link">
<span class="md-ellipsis">
Security
</span>
</a>
</li>
<li class="md-nav__item">
<a href="common/" class="md-nav__link">
<span class="md-ellipsis">
Common
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4" >
<label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
<span class="md-ellipsis">
Persistence & Security
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_4">
<span class="md-nav__icon md-icon"></span>
Persistence & Security
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../repository/" class="md-nav__link">
<span class="md-ellipsis">
Repository
</span>
</a>
</li>
<li class="md-nav__item">
<a href="mongo/" class="md-nav__link">
<span class="md-ellipsis">
Mongo
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../security/" class="md-nav__link">
<span class="md-ellipsis">
Security
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_5" >
<label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
<span class="md-ellipsis">
Support & Utilities
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_5">
<span class="md-nav__icon md-icon"></span>
Support & Utilities
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../utils/" class="md-nav__link">
<span class="md-ellipsis">
Utils
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../exceptions/" class="md-nav__link">
<span class="md-ellipsis">
Exceptions
</span>
</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="#jwtlib.models" class="md-nav__link">
<span class="md-ellipsis">
models
</span>
</a>
<nav class="md-nav" aria-label="models">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#jwtlib.models--jwtlib-models-structured-data-for-authentication" class="md-nav__link">
<span class="md-ellipsis">
jwtlib Models: Structured Data for Authentication
</span>
</a>
<nav class="md-nav" aria-label="jwtlib Models: Structured Data for Authentication">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#jwtlib.models--model-categories" class="md-nav__link">
<span class="md-ellipsis">
Model Categories
</span>
</a>
<nav class="md-nav" aria-label="Model Categories">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#jwtlib.models--1-api-requests" class="md-nav__link">
<span class="md-ellipsis">
1. API Requests
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#jwtlib.models--2-api-responses" class="md-nav__link">
<span class="md-ellipsis">
2. API Responses
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#jwtlib.models--3-internal-security" class="md-nav__link">
<span class="md-ellipsis">
3. Internal &amp; Security
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#jwtlib.models--usage-patterns" class="md-nav__link">
<span class="md-ellipsis">
Usage Patterns
</span>
</a>
<nav class="md-nav" aria-label="Usage Patterns">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#jwtlib.models--validating-an-auth-request" class="md-nav__link">
<span class="md-ellipsis">
Validating an Auth Request
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#jwtlib.models--projecting-a-user-to-public-view" class="md-nav__link">
<span class="md-ellipsis">
Projecting a User to Public View
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#jwtlib.models.IntrospectRequest" class="md-nav__link">
<span class="md-ellipsis">
IntrospectRequest
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#jwtlib.models.IntrospectResponse" class="md-nav__link">
<span class="md-ellipsis">
IntrospectResponse
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#jwtlib.models.LoginRequest" class="md-nav__link">
<span class="md-ellipsis">
LoginRequest
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#jwtlib.models.LoginResponse" class="md-nav__link">
<span class="md-ellipsis">
LoginResponse
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#jwtlib.models.LogoutResponse" class="md-nav__link">
<span class="md-ellipsis">
LogoutResponse
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#jwtlib.models.PublicUser" class="md-nav__link">
<span class="md-ellipsis">
PublicUser
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#jwtlib.models.RegisterRequest" class="md-nav__link">
<span class="md-ellipsis">
RegisterRequest
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#jwtlib.models.TokenPayload" class="md-nav__link">
<span class="md-ellipsis">
TokenPayload
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#jwtlib.models.User" class="md-nav__link">
<span class="md-ellipsis">
User
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-content" data-md-component="content">
<article class="md-content__inner md-typeset">
<h1 id="models">Models</h1>
<div class="doc doc-object doc-module">
<h2 id="jwtlib.models" class="doc doc-heading">
<span class="doc doc-object-name doc-module-name">jwtlib.models</span>
</h2>
<div class="doc doc-contents first">
<h3 id="jwtlib.models--jwtlib-models-structured-data-for-authentication">jwtlib Models: Structured Data for Authentication</h3>
<p>This package defines the core data models used by <code>jwtlib</code>. These models are
categorized into request payloads, response objects, persistence documents,
and security context.</p>
<h4 id="jwtlib.models--model-categories">Model Categories</h4>
<h5 id="jwtlib.models--1-api-requests">1. API Requests</h5>
<ul>
<li><strong>RegisterRequest</strong>: Payload for creating new user accounts.</li>
<li><strong>LoginRequest</strong>: User credentials for issuing JWTs.</li>
<li><strong>IntrospectRequest</strong>: Internal payload for service-to-service token verification.</li>
</ul>
<h5 id="jwtlib.models--2-api-responses">2. API Responses</h5>
<ul>
<li><strong>PublicUser</strong>: A safe, non-sensitive projection of a user profile.</li>
<li><strong>LoginResponse</strong>: Contains the issued <code>access_token</code> and the <code>PublicUser</code>.</li>
<li><strong>LogoutResponse</strong>: Instruction for clients to clear stateless session state.</li>
</ul>
<h5 id="jwtlib.models--3-internal-security">3. Internal &amp; Security</h5>
<ul>
<li><strong>User</strong>: The MongoDB-backed persistence model (Confined to repository layer).</li>
<li><strong>TokenPayload</strong>: Decoded claims from a validated JWT (sub, exp).</li>
<li><strong>IntrospectResponse</strong>: Structured result of a token validity check.</li>
</ul>
<h4 id="jwtlib.models--usage-patterns">Usage Patterns</h4>
<h5 id="jwtlib.models--validating-an-auth-request">Validating an Auth Request</h5>
<pre><code class="language-python">from jwtlib.models import LoginRequest
from pydantic import ValidationError
try:
auth_data = LoginRequest(username=&quot;tester&quot;, password=&quot;secure_password&quot;)
except ValidationError as e:
print(f&quot;Invalid request data: {e.json()}&quot;)
</code></pre>
<h5 id="jwtlib.models--projecting-a-user-to-public-view">Projecting a User to Public View</h5>
<pre><code class="language-python">from jwtlib.models import User, PublicUser
# Assuming 'db_user' is an instance of User fetched from MongoDB
user_profile = PublicUser.model_validate(db_user, from_attributes=True)
print(f&quot;Safe to return: {user_profile.username} ({user_profile.email})&quot;)
</code></pre>
<p>All models are built on Pydantic v2 and provide full type safety for both
static analysis (Mypy/Pyright) and runtime validation.</p>
<div class="doc doc-children">
<div class="doc doc-object doc-class">
<h3 id="jwtlib.models.IntrospectRequest" class="doc doc-heading">
<span class="doc doc-object-name doc-class-name">IntrospectRequest</span>
</h3>
<div class="doc doc-contents ">
<p class="doc doc-class-bases">
Bases: <code><span title="pydantic.BaseModel">BaseModel</span></code></p>
<p>Payload for requesting token introspection.</p>
<p>Used by internal services to verify the validity of a JWT and retrieve
the associated public user information.</p>
<details class="fields" open>
<summary>Fields</summary>
<p>token: JWT access token to introspect.</p>
</details>
<details class="notes" open>
<summary>Notes</summary>
<ul>
<li>Intended for service-to-service communication.</li>
<li>Not meant for direct end-user consumption.</li>
</ul>
</details>
<div class="doc doc-children">
</div>
</div>
</div>
<div class="doc doc-object doc-class">
<h3 id="jwtlib.models.IntrospectResponse" class="doc doc-heading">
<span class="doc doc-object-name doc-class-name">IntrospectResponse</span>
</h3>
<div class="doc doc-contents ">
<p class="doc doc-class-bases">
Bases: <code><span title="pydantic.BaseModel">BaseModel</span></code></p>
<p>Result of a token introspection operation.</p>
<p>This model communicates whether a JWT is valid and, if so, provides
the associated public user information.</p>
<details class="fields" open>
<summary>Fields</summary>
<p>active: Indicates whether the token is valid and active.
user: Public user details if the token is valid; otherwise null.</p>
</details>
<details class="notes" open>
<summary>Notes</summary>
<ul>
<li>This model is designed to avoid raising exceptions.</li>
<li>All introspection outcomes are represented as data.</li>
</ul>
</details>
<div class="doc doc-children">
</div>
</div>
</div>
<div class="doc doc-object doc-class">
<h3 id="jwtlib.models.LoginRequest" class="doc doc-heading">
<span class="doc doc-object-name doc-class-name">LoginRequest</span>
</h3>
<div class="doc doc-contents ">
<p class="doc doc-class-bases">
Bases: <code><span title="jwtlib.models.common.IdentityMixin">IdentityMixin</span></code>, <code><span title="jwtlib.models.common.PasswordMixin">PasswordMixin</span></code></p>
<p>Payload for authenticating a user and issuing a JWT.</p>
<p>This model is used to verify user credentials and request an access token.</p>
<details class="fields" open>
<summary>Fields</summary>
<p>username: Username identifier.
password: Plain-text password to be verified.</p>
</details>
<details class="notes" open>
<summary>Notes</summary>
<ul>
<li>Successful authentication results in a LoginResponse.</li>
<li>Failed authentication raises an AuthError.</li>
</ul>
</details>
<div class="doc doc-children">
</div>
</div>
</div>
<div class="doc doc-object doc-class">
<h3 id="jwtlib.models.LoginResponse" class="doc doc-heading">
<span class="doc doc-object-name doc-class-name">LoginResponse</span>
</h3>
<div class="doc doc-contents ">
<p class="doc doc-class-bases">
Bases: <code><span title="pydantic.BaseModel">BaseModel</span></code></p>
<p>Response returned after successful authentication.</p>
<p>Contains the issued JWT access token and the authenticated user's
public profile.</p>
<details class="fields" open>
<summary>Fields</summary>
<p>access_token: JWT access token for authenticated requests.
user: Public profile of the authenticated user.</p>
</details>
<details class="notes" open>
<summary>Notes</summary>
<ul>
<li>The token is stateless and must be stored client-side.</li>
<li>Token expiration and validation are handled elsewhere.</li>
</ul>
</details>
<div class="doc doc-children">
</div>
</div>
</div>
<div class="doc doc-object doc-class">
<h3 id="jwtlib.models.LogoutResponse" class="doc doc-heading">
<span class="doc doc-object-name doc-class-name">LogoutResponse</span>
</h3>
<div class="doc doc-contents ">
<p class="doc doc-class-bases">
Bases: <code><span title="pydantic.BaseModel">BaseModel</span></code></p>
<p>Response returned after a logout operation.</p>
<p>Since logout is stateless, this response serves only as a confirmation
message instructing the client to discard its token.</p>
<details class="fields" open>
<summary>Fields</summary>
<p>message: Human-readable logout confirmation.</p>
</details>
<div class="doc doc-children">
</div>
</div>
</div>
<div class="doc doc-object doc-class">
<h3 id="jwtlib.models.PublicUser" class="doc doc-heading">
<span class="doc doc-object-name doc-class-name">PublicUser</span>
</h3>
<div class="doc doc-contents ">
<p class="doc doc-class-bases">
Bases: <code><span title="jwtlib.models.common.IdentityMixin">IdentityMixin</span></code>, <code><span title="jwtlib.models.common.ActiveStateMixin">ActiveStateMixin</span></code></p>
<p>Public-facing user representation returned by authentication APIs.</p>
<p>This model represents a user profile that is safe to expose outside
the authentication system.</p>
<details class="fields" open>
<summary>Fields</summary>
<p>username: Unique username identifier.
email: User's email address.
is_active: Whether the user account is active.</p>
</details>
<details class="notes" open>
<summary>Notes</summary>
<ul>
<li>Contains no sensitive data.</li>
<li>Can be constructed from persistence models via <code>from_attributes</code>.</li>
</ul>
</details>
<div class="doc doc-children">
</div>
</div>
</div>
<div class="doc doc-object doc-class">
<h3 id="jwtlib.models.RegisterRequest" class="doc doc-heading">
<span class="doc doc-object-name doc-class-name">RegisterRequest</span>
</h3>
<div class="doc doc-contents ">
<p class="doc doc-class-bases">
Bases: <code><span title="jwtlib.models.common.IdentityMixin">IdentityMixin</span></code>, <code><span title="jwtlib.models.common.PasswordMixin">PasswordMixin</span></code></p>
<p>Payload for registering a new user account.</p>
<p>This model contains the minimum required identity and credential
information to create a new user.</p>
<details class="fields" open>
<summary>Fields</summary>
<p>username: Unique username identifier.
email: User's email address.
password: Plain-text password (to be hashed by the repository layer).</p>
</details>
<details class="notes" open>
<summary>Notes</summary>
<ul>
<li>Validation and normalization handled by mixins.</li>
<li>This model is never returned in responses.</li>
</ul>
</details>
<div class="doc doc-children">
</div>
</div>
</div>
<div class="doc doc-object doc-class">
<h3 id="jwtlib.models.TokenPayload" class="doc doc-heading">
<span class="doc doc-object-name doc-class-name">TokenPayload</span>
</h3>
<div class="doc doc-contents ">
<p class="doc doc-class-bases">
Bases: <code><span title="pydantic.BaseModel">BaseModel</span></code></p>
<p>Decoded JWT payload.</p>
<p>Represents the validated claims extracted from a JWT after signature
verification. This model is used internally to enforce required claims
and provide a typed interface to token data.</p>
<details class="fields" open>
<summary>Fields</summary>
<p>sub: Subject claim identifying the user (typically a username or user ID).
exp: Expiration time as a Unix timestamp (seconds since epoch).</p>
</details>
<details class="notes" open>
<summary>Notes</summary>
<ul>
<li>This model assumes the JWT signature has already been verified.</li>
<li>No authorization decisions should be made solely on this model.</li>
<li>Additional claims may exist but are intentionally ignored.</li>
</ul>
</details>
<div class="doc doc-children">
</div>
</div>
</div>
<div class="doc doc-object doc-class">
<h3 id="jwtlib.models.User" class="doc doc-heading">
<span class="doc doc-object-name doc-class-name">User</span>
</h3>
<div class="doc doc-contents ">
<p class="doc doc-class-bases">
Bases: <code><span title="mongo_ops.BaseDocument">BaseDocument</span></code>, <code><span title="jwtlib.models.common.IdentityMixin">IdentityMixin</span></code>, <code><span title="jwtlib.models.common.ActiveStateMixin">ActiveStateMixin</span></code></p>
<p>Internal user persistence model.</p>
<p>Represents a user record as stored in the database. This model
includes sensitive fields and is strictly confined to the
persistence layer.</p>
<details class="fields" open>
<summary>Fields</summary>
<p>hashed_password: Secure hash of the user's password.</p>
</details>
<details class="notes" open>
<summary>Notes</summary>
<ul>
<li>This model MUST NOT be returned from authentication APIs.</li>
<li>Consumers should use <code>PublicUser</code> instead.</li>
<li>Password verification is handled by the repository layer.</li>
<li>Inherits identity and active-state behavior via mixins.</li>
</ul>
</details>
<div class="doc doc-children">
</div>
</div>
</div>
</div>
</div>
</div>
</article>
</div>
<script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
</div>
<button type="button" class="md-top md-icon" data-md-component="top" hidden>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8z"/></svg>
Back to top
</button>
</main>
<footer class="md-footer">
<div class="md-footer-meta md-typeset">
<div class="md-footer-meta__inner md-grid">
<div class="md-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": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "../../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
<script src="../../assets/javascripts/bundle.f55a23d4.min.js"></script>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink