API Reference
Every public symbol in crudauth, generated from the source docstrings. Unless a page notes
otherwise, each is importable straight from the top-level crudauth package.
Core
| Page |
What's in it |
| CRUDAuth |
The composition root. Configure transports, mount routers, and build the current_user() / rate_limit() / require_sudo() route guards. |
| Principal |
The identity object every transport returns. |
| Core types |
CookieConfig, AuthContext, AuthRuntime. |
Transports
| Page |
What's in it |
| Transports |
The Transport port, the built-in SessionTransport and BearerTransport, and the SessionManager behind server-side sessions. |
Accounts & flows
| Page |
What's in it |
| OAuth |
Credentials, the provider port and factory, and account linking. |
| Email |
EmailConfig, the EmailSender port, and EmailFlowService. |
| Hooks |
AuthHooks lifecycle callbacks and HookContext. |
| Sudo |
SudoConfig and SudoManager for re-authentication. |
Data layer
| Page |
What's in it |
| UserRepository |
The logical-field to column adapter over your model. |
| Models |
AuthUserMixin. |
Infrastructure
| Page |
What's in it |
| Rate limiting & lockout |
RateLimit, KeyBy, LockoutPolicy, and the limiter backends. |
| Storage |
The session/CSRF/token store port and its memory and Redis backends. |
Errors & helpers
| Page |
What's in it |
| Exceptions |
The HTTP exception hierarchy. |
| Utilities |
Password hashing, email normalization, client IP, and display masking. |