SDK Reference¶
This section contains API reference documentation for the sentinel-auth-sdk Python package, auto-generated from source code docstrings using mkdocstrings.
Each page corresponds to a module in the sentinel_auth package:
| Module | Description |
|---|---|
| Types | Data classes (AuthenticatedUser, WorkspaceContext) used throughout the SDK |
| Middleware | JWTAuthMiddleware for validating tokens on incoming requests |
| Dependencies | FastAPI dependency functions for injecting user/workspace context |
| Permissions | PermissionClient for interacting with the permissions API |
Usage¶
Install the SDK in your service:
Then import what you need:
from sentinel_auth.types import AuthenticatedUser
from sentinel_auth.middleware import JWTAuthMiddleware
from sentinel_auth.dependencies import get_current_user, get_workspace
from sentinel_auth.permissions import PermissionClient
Docstring format
All docstrings follow Google style. Parameters, return types, and raised exceptions are documented inline in the source and rendered here automatically.