appkit-user
Enterprise user management and authentication for Reflex applications.
appkit-user provides comprehensive user authentication, authorization, and management capabilities for Reflex applications. It includes OAuth2 integration with GitHub and Azure, role-based access control (RBAC), multi-tenant user profiles, and secure session management.
✨ Features
- OAuth2 Authentication - GitHub and Azure OAuth2 providers with PKCE support
- Role-Based Access Control - Flexible RBAC with custom roles and permissions
- Multi-Tenant Support - User profiles organized by tenants and projects
- Session Management - Secure session handling with automatic cleanup
- User Management UI - Complete admin interface for user CRUD operations
- Authentication Decorators - Easy-to-use decorators for protecting routes and components
- Profile Management - User profile editing with role assignment
- Login Throttling - Lockout after repeated failed password logins, per email and per client address
- Forced Password Reset - Users flagged
needs_password_resetget a one-time reset link instead of a session - Security Features - CSRF protection, secure redirects, and session validation
🚀 Installation
As Part of AppKit Workspace
If you're using the full AppKit workspace:
git clone https://github.com/jenreh/appkit.git
cd appkit
uv sync
Standalone Installation
Install from PyPI:
pip install appkit-user
Or with uv:
uv add appkit-user
Dependencies
greenlet>=3.2.4(async utilities)appkit-commons(shared utilities)appkit-mantine(Mantine UI components)requests_oauthlib>=2.0.0(OAuth2 client)
🏁 Quick Start
Basic OAuth Configuration
Configure OAuth providers in your application:
from appkit_user.configuration import GithubOAuthConfig, AzureOAuthConfig
# GitHub OAuth
github_config = GithubOAuthConfig(
client_id="your-github-client-id",
client_secret="secret:github-client-secret",
redirect_url="http://localhost:3000/auth/github/callback",
)
# Azure OAuth
azure_config = AzureOAuthConfig(
client_id="your-azure-client-id",
client_secret="secret:azure-client-secret",
tenant_id="your-tenant-id",
redirect_url="http://localhost:3000/auth/azure/callback",
)
Protecting Routes
Use authentication decorators to protect your pages:
import reflex as rx
from appkit_user.authentication.components import requires_authenticated, requires_role
# Require authentication
@requires_authenticated
def protected_page():
return rx.text("This page requires login")
# Require specific role
@requires_role("admin")
def admin_page():
return rx.text("Admin only content")
# Require admin privileges
@requires_admin
def super_admin_page():
return rx.text("Super admin content")
Login Integration
Add login functionality to your app:
from appkit_user.authentication.components import login_form
def login_page():
return login_form(
header="My App", logo="/img/logo.svg", logo_dark="/img/logo_dark.svg"
)
Page factories
authenticated_page takes the page layout from the app through its template
argument:
from appkit_user.authentication.templates import authenticated_page
def my_template(content: rx.Component) -> rx.Component:
return mn.app_shell(mn.app_shell.main(content))
@authenticated_page(route="/settings", title="Settings", template=my_template)
def settings_page() -> rx.Component:
return rx.box("Settings")
authenticated_page is the only page decorator in appkit-user. It adds the session
monitor and the admin_only gate. Theming comes from appkit-mantine
(mn.theme_wrapper). Layouts such as a splash page or a page with a navbar belong
in the app.
The login and password-reset page factories take the app's page decorator factory
as their first argument. It is called as
layout(route=..., title=..., on_load=...) and must return a page decorator
(see the PageLayout protocol in appkit_user.user_management.pages).
from appkit_user.user_management.pages import (
create_login_page,
create_password_reset_confirm_page,
create_password_reset_request_page,
)
from app.components.templates import default_layout # your app's layout
create_login_page(default_layout)
create_password_reset_request_page(default_layout)
create_password_reset_confirm_page(default_layout)
There is no profile page factory. Build the page in your app around
user_profile_view() from appkit_user.user_management.components.user_profile.
📖 Usage
OAuth Configuration
GitHub OAuth
Configure GitHub OAuth application:
from appkit_user.configuration import GithubOAuthConfig
config = GithubOAuthConfig(
client_id="gh_oauth_client_id",
client_secret="secret:github_oauth_secret",
redirect_url="https://myapp.com/auth/github/callback",
scopes=["user", "user:email", "read:org"], # Optional custom scopes
)
Azure OAuth
Configure Azure AD application:
from appkit_user.configuration import AzureOAuthConfig
config = AzureOAuthConfig(
client_id="azure_client_id",
client_secret="secret:azure_client_secret",
tenant_id="tenant-id", # or "common" for multi-tenant
redirect_url="https://myapp.com/auth/azure/callback",
is_public_client=False, # Set to True for PKCE-only apps
scopes=["openid", "profile", "email", "User.Read"],
)
Authentication Decorators
Basic Authentication
from appkit_user.authentication.components import requires_authenticated
@requires_authenticated
def dashboard():
return rx.text("Welcome to your dashboard!")
Role-Based Access
from appkit_user.authentication.components import requires_role
@requires_role("editor")
def content_editor():
return rx.text("Content editor interface")
@requires_role("viewer", fallback=rx.text("Access denied"))
def reports():
return rx.text("Reports dashboard")
Admin Access
from appkit_user.authentication.components import requires_admin
@requires_admin
def admin_panel():
return rx.text("Admin control panel")
User Management
User Table
Display and manage users:
from appkit_user.user_management.components import users_table
from appkit_user.user_management.states.user_states import UserState
# users_table does not fetch on its own; load users via the page's on_load.
@rx.page(route="/admin/users", on_load=UserState.load_users)
def user_management_page():
return rx.vstack(rx.heading("User Management"), users_table(), spacing="4")
User Profile
Manage user profiles and roles:
from appkit_user.user_management.components import profile_roles, profile_state
def user_profile_page():
return rx.vstack(rx.heading("User Profile"), profile_roles(), spacing="4")
Session Management
Access current user session:
from appkit_user.authentication.states import UserSession
def current_user_info():
return rx.vstack(
rx.text(f"User: {UserSession.user.email}"),
rx.text(f"Roles: {UserSession.user.roles}"),
rx.text(f"Tenant: {UserSession.user.tenant_id}"),
rx.text(f"Authenticated: {UserSession.is_authenticated}"),
)
🔧 Configuration
OAuth Redirect URLs
Configure OAuth callback URLs in your Reflex app:
# In rxconfig.py or main app file
app.add_page(oauth_login_splash, route="/auth/github/callback", title="GitHub Login")
app.add_page(oauth_login_splash, route="/auth/azure/callback", title="Azure Login")
Custom OAuth Providers
Extend OAuth support for custom providers:
from appkit_user.configuration import OAuthConfig, OAuthProvider
class CustomOAuthConfig(OAuthConfig):
provider: OAuthProvider = "custom"
auth_url: str = "https://custom.provider.com/oauth/authorize"
token_url: str = "https://custom.provider.com/oauth/token"
user_url: str = "https://custom.provider.com/api/user"
scopes: list[str] = ["read", "write"]
Multi-Tenant Setup
Configure tenant-based user isolation:
# Users are automatically scoped by tenant_id
# Access current tenant
current_tenant = UserSession.user.tenant_id
# Filter data by tenant
tenant_users = get_users_by_tenant(current_tenant)
📋 API Reference
Authentication Components
requires_authenticated()- Decorator for authentication-required contentrequires_role()- Decorator for role-based access controlrequires_admin()- Decorator for admin-only contentlogin_form()- Login form with OAuth providersoauth_login_splash()- OAuth callback splash screendefault_fallback()- Default unauthorized access message
User Management Components
users_table()- User management table with CRUD operationsadd_user_button()- Button to add new usersupdate_user_button()- Button to edit existing usersdelete_user_button()- Button to remove usersuser_form_fields()- Form fields for user creation/editingprofile_roles()- User profile role managementprofile_state()- User profile state management
Configuration Classes
OAuthConfig- Base OAuth configurationGithubOAuthConfig- GitHub OAuth settingsAzureOAuthConfig- Azure AD OAuth settingsOAuthProvider- Enum of supported OAuth providersPasswordResetConfig- Password reset token expiry, request limit, email templatesLoginRateLimitConfig- Failed-login throttle (enabled,max_attempts,max_attempts_per_client,window_minutes,lockout_minutes)
State Management
UserSession- Current user session stateLoginState- Login form state management
🔒 Security
- OAuth2 PKCE Support - Proof Key for Code Exchange for enhanced security
- Secure Redirects - Configurable redirect URLs prevent open redirect attacks
- Login Throttle - Failed password logins are counted per email (default 5) and per client address (default 20) within 15 minutes; a locked key is refused for 15 minutes before the password is checked. Configure via
authentication.login_rate_limit. Counters live in theauth_login_throttletable (hashed keys, fixed window), so the limit holds across workers and restarts; add the table with the Alembic migration of your app. Behind a proxy setreflex.trusted_proxy_hopsso client addresses are real. - Session Security - Automatic session cleanup and validation
- CSRF Protection - Built-in CSRF tokens for forms
- Role Validation - Server-side role checking in addition to client-side decorators
- Tenant Isolation - Multi-tenant data isolation prevents cross-tenant access
🤝 Integration Examples
Complete Authentication Flow
Set up a full authentication system:
import reflex as rx
from appkit_user.authentication.components import (
login_form,
requires_authenticated,
oauth_login_splash,
)
from appkit_user.configuration import GithubOAuthConfig
# Configure OAuth
oauth_config = GithubOAuthConfig(
client_id="your-client-id", client_secret="secret:your-client-secret"
)
# Public login page
def login():
return login_form(
header="My App", logo="/img/logo.svg", logo_dark="/img/logo_dark.svg"
)
# Protected dashboard
@requires_authenticated
def dashboard():
return rx.text(f"Welcome {UserSession.user.email}!")
# OAuth callback
def github_callback():
return oauth_login_splash(provider="github", message="Signing in with GitHub...")
# Add to app
app = rx.App()
app.add_page(login, route="/login")
app.add_page(dashboard, route="/dashboard")
app.add_page(github_callback, route="/auth/github/callback")
User Management System
Create an admin user management interface:
from appkit_user.user_management.components import users_table
from appkit_user.authentication.components import requires_admin
@requires_admin
def admin_users():
return rx.vstack(
rx.heading("User Management", size="5"),
rx.flex(users_table(), direction="column", gap="4", width="100%"),
padding="6",
spacing="4",
)
Role-Based Navigation
Dynamic navigation based on user roles:
def navigation():
return rx.hstack(
rx.link("Home", href="/"),
rx.cond(
UserSession.is_authenticated,
rx.hstack(
rx.link("Dashboard", href="/dashboard"),
rx.cond(
UserSession.user.roles.contains("admin"),
rx.link("Admin", href="/admin"),
rx.text(""), # Empty for non-admins
),
rx.button("Logout", on_click=UserSession.logout),
),
rx.link("Login", href="/login"),
),
)
📚 Related Components
- appkit-commons - Shared utilities and configuration
- appkit-assistant - AI assistant with user authentication
- appkit-mantine - Form components for user management
Metadata
Release files for appkit-user 1.19.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| appkit_user-1.19.1.tar.gz | 894.4 kB | Without provenance | Details for appkit_user-1.19.1.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| appkit_user-1.19.1-py3-none-any.whl | Python 3 | none | any | Details for appkit_user-1.19.1-py3-none-any.whl |
Total release size: 981.9 kB
Release files / appkit_user-1.19.1.tar.gz
| Download URL | appkit_user-1.19.1.tar.gz |
|---|---|
| Size | 894.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
4d7e3b6709e8ca96dd5ecb74ea0de941ff1a86878e7a88feca41b4e3469c416d
|
|
BLAKE2b-256 checksum How to use checksums |
851b3167704d53c035b5d2d8f7968309950b7c172344200299ab37910a844b7a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.13.6 {"installer":{"name":"uv","version":"0.13.6","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"26.04","id":"resolute","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
Release files / appkit_user-1.19.1-py3-none-any.whl
| Download URL | appkit_user-1.19.1-py3-none-any.whl |
|---|---|
| Size | 87.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
c9296b683080371a0c0ea48f225db4b4f58b71a9ee381f0e6487af425c2d8361
|
|
BLAKE2b-256 checksum How to use checksums |
cff9bb901a8467b37b367012d9015926d05c5dae805236063b2ec32f33fb36b6
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.13.6 {"installer":{"name":"uv","version":"0.13.6","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"26.04","id":"resolute","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
Security for appkit-user 1.19.1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.