Skip to main content

AgentAdmit SDK: user-mediated AI agent authorization for any app

Project description

AgentAdmit SDK for Python

User-mediated AI agent authorization for Python apps. Supports FastAPI, Flask, and Django.

Get started: Sign up at agentadmit.com and get your test keys. Install the SDK and build. Test Mode keys are available immediately after signup. Live keys become available when you subscribe an app.

Quick Start

pip install agentadmit
agentadmit init

Edit agentadmit.yaml to define your scopes, then add to your FastAPI app:

from fastapi import FastAPI, Depends
from agentadmit import AgentAdmitMiddleware, require_scope_if_agent, get_current_user_or_agent

app = FastAPI()

# One-line setup
app.add_middleware(
    AgentAdmitMiddleware,
    config_path="agentadmit.yaml",
    get_current_user=your_auth_dependency,
    verify_user_token=your_token_verifier,
    users_collection="users",
)

# Add scope enforcement to any route
@app.get("/api/orders")
async def get_orders(
    auth_ctx=Depends(get_current_user_or_agent),
    _scope=Depends(require_scope_if_agent("read:orders")),
):
    user = auth_ctx["user"]
    # Your existing logic - unchanged
    return {"orders": get_orders_for_user(user["user_id"])}

Your app now supports AI agent connections with:

  • Scoped access control (you define the scopes)
  • User-controlled connection duration
  • Token generation and exchange
  • Revocation
  • Audit logging

How It Works

  1. User clicks "AgentAdmit" in your app
  2. Selects scopes and connection duration
  3. Gets a token to give to their AI agent
  4. Agent exchanges the token for scoped API access
  5. User revokes anytime

The token goes to the human, not the agent. No automated delivery = no prompt injection surface.

CLI

agentadmit init      # Generate agentadmit.yaml config file
agentadmit check     # Validate configuration and show scope summary
agentadmit sync      # Sync scopes from agentadmit.yaml to the hosted service
agentadmit keys      # Prints a deprecation notice (hosted service holds keys)

Flask Integration

from flask import Flask
from agentadmit.integrations.flask_integration import AgentAdmitFlask

app = Flask(__name__)
aa = AgentAdmitFlask(app, config_path="agentadmit.yaml")

@app.route('/api/orders')
@aa.require_scope_if_agent('read:orders')
def get_orders():
    return get_user_orders()

Django Integration

# settings.py
AGENTADMIT_CONFIG = {
    'APP_ID': 'app_yourappid',
    'API_KEY': 'aa_test_yourkey',
    'VERIFY_URL': 'https://api.agentadmit.com/api/v1/verify',
}

# views.py
from agentadmit.integrations.django_integration import require_scope_if_agent

@require_scope_if_agent('read:orders')
def get_orders(request):
    return get_user_orders(request)

MCP Server Integration

Building an MCP server in Python? AgentAdmit is the auth layer. MCP servers are app owners. Same SDK, same pricing.

For STDIO transport (most MCP servers), the agent includes the token in tool arguments:

import requests
import os

AGENTADMIT_VERIFY_URL = "https://api.agentadmit.com/api/v1/verify"
AGENTADMIT_API_KEY = os.environ["AGENTADMIT_API_KEY"]

def handle_tool_call(name: str, arguments: dict) -> dict:
    # 1. Extract token from tool arguments
    token = arguments.pop("agentadmit_token", None)
    if not token:
        raise PermissionError("agentadmit_token required")
    
    # 2. Validate via AgentAdmit hosted service
    resp = requests.post(
        AGENTADMIT_VERIFY_URL,
        headers={
            "Authorization": f"Bearer {AGENTADMIT_API_KEY}",
            "Content-Type": "application/json",
        },
        json={"token": token},
        timeout=5,
    )
    if resp.status_code != 200:
        raise RuntimeError(f"AgentAdmit verification failed: {resp.status_code}")
    ctx = resp.json()
    # Invalid / expired / revoked tokens return HTTP 200 with active: false
    if not ctx.get("active"):
        raise PermissionError("Invalid or expired token")
    
    # 3. Check scope for this tool
    required_scope = SCOPE_MAP.get(name)
    if required_scope and required_scope not in ctx.get("scopes", []):
        raise PermissionError(f"Missing scope '{required_scope}'")
    
    # 4. Run the tool
    return TOOL_HANDLERS[name](arguments, ctx)

For HTTP transport (FastAPI-based MCP servers), use the full SDK middleware. The agent sends the token via Authorization: Bearer header, same as any HTTP API.

Full MCP integration guide with complete before/after examples: agentadmit.com/docs/mcp-guide

MCP operators: You also get admin scopes for your own AI agent to monitor your server and full audit trail for billing. See the Admin Panel section in the dashboard for details.

Important

Mandatory introspection. All token validation goes through api.agentadmit.com. There is no self-hosted mode. No local JWT validation. No bypass. This is required for security, audit logging, and scope enforcement.

User revocation. Users can revoke any of their own agent connections via DELETE /agentadmit/connections/{connection_id} (requires the user to be authenticated via your app's session). The SDK router registers this endpoint when you call create_agentadmit_router().

In-app AI scopes. If your app has built-in AI features (analysis, plan generation, photo recognition), do not expose those as agent scopes. The user's AI agent can read the raw data and do the analysis itself. Exposing in-app AI endpoints to agents creates double cost.

Consent Ledger (Caller-Identity Consent)

AgentAdmit can host per-user consent switches for three independent caller classes: human_session, in_app_ai, and external_agent. No class's setting implies another's.

External agents: the verify response already carries the verdict; it appears on the agent context as auth_ctx["consent"] when present:

consent = auth_ctx.get("consent")
if consent and not consent["granted"]:
    raise HTTPException(403, "The data owner has not enabled external agent access.")

Human sessions and in-app AI never hold AgentAdmit tokens, so ask directly:

from agentadmit import check_consent

verdict = check_consent(app_user_id="user_8842", caller_class="in_app_ai")
if not verdict["granted"]:
    ...  # do not run AI over this user's data

Consent is orthogonal to revocation: a denied verdict means your app returns its own 403; the connection and token stay valid so the user can flip consent back on without re-connecting. Write switches through PUT /api/v1/consent/settings from your backend; export the audit trail with GET /api/v1/consent/export (every plan).

Presence Verification (WebAuthn Step-Up)

The verify response can carry a human-presence fact for the connection: whether the person who authorized it completed a WebAuthn ceremony on the consent page. It appears on the agent context as auth_ctx["presence"] when the platform returns it. Older servers omit it, and verified is false for connections minted without a ceremony (direct-API tokens, presence-off sessions, pre-presence connections).

from agentadmit import presence_verified

if not presence_verified(auth_ctx):
    ...  # not presence-verified; absent or malformed data never counts as verified

Guard sensitive endpoints with the fail-closed dependency; a connection without a completed ceremony gets a 403 presence_required:

from agentadmit import require_presence

@app.post("/api/transfers")
async def create_transfer(agent_ctx=Depends(require_presence())):
    ...

Flask and Django ship the same guard: @aa.require_presence() on the Flask integration, and require_presence() from agentadmit.integrations.django_integration.

Rate Limiting

The AgentAdmit introspection endpoint enforces rate limits. The Python SDK handles HTTP 429 responses automatically with exponential backoff and jitter - no changes needed in your app code.

Retry behavior

Parameter Default Description
Initial delay 1 second First retry wait
Backoff multiplier 2x Doubles each retry
Cap 30 seconds Maximum wait per retry
Jitter 0-500 ms Random addition to each delay
Max retries 3 Configurable

The SDK also respects the Retry-After response header - if present, it overrides the computed backoff delay.

Configuring max retries

In agentadmit.yaml:

max_retries: 5  # default: 3. Set to 0 to disable retries.

Handling exhausted retries

When all retries are exhausted, the SDK raises RateLimitError:

from agentadmit.exceptions import RateLimitError

try:
    # Any endpoint protected with require_scope / get_agentadmit_user
    ...
except RateLimitError as e:
    print(f"Rate limited. Retry after {e.retry_after}s")
    print(f"Limit: {e.limit}, Remaining: {e.remaining}, Reset: {e.reset}")
    # Return 429 to the caller or queue for retry

RateLimitError attributes:

  • retry_after - seconds from Retry-After header (or None)
  • limit - X-RateLimit-Limit header value (or None)
  • remaining - X-RateLimit-Remaining header value (or None)
  • reset - X-RateLimit-Reset Unix timestamp (or None)

Route Registration Order (FastAPI)

When using create_agentadmit_router(), the SDK registers default endpoints for /agentadmit/scopes, /agentadmit/connections/generate-token, etc.

If you need to override any SDK endpoint with your own (e.g., a user-aware /scopes endpoint), register your route before calling app.include_router(). FastAPI resolves routes in registration order - the first matching route wins.

# Correct: custom /scopes registered before SDK router
@app.get("/agentadmit/scopes")
async def my_scopes(current_user: dict = Depends(get_current_user)):
    # your user-aware logic
    ...

wellknown_router, agentadmit_router = create_agentadmit_router(...)
app.include_router(wellknown_router)
app.include_router(agentadmit_router, prefix="/agentadmit")

# Wrong: custom route registered AFTER SDK router (shadowed, never reached)
wellknown_router, agentadmit_router = create_agentadmit_router(...)
app.include_router(agentadmit_router, prefix="/agentadmit")  # SDK route wins
@app.get("/agentadmit/scopes")  # never reached
async def my_scopes(): ...

Tip: Use the filter_scopes_for_user callback parameter on create_agentadmit_router() as a cleaner alternative to overriding /scopes entirely - the SDK handles the endpoint and calls your function to filter results.

Documentation

Full integration guide: https://agentadmit.com/docs/app-owner-guide

Data Collection & Privacy

The AgentAdmit Python SDK runs server-side and does not interact with app stores or end-user devices directly.

What the SDK does

  • Validates AgentAdmit tokens by calling AgentAdmit's hosted introspection endpoint (https://api.agentadmit.com/api/v1/verify) on every agent request - this is mandatory introspection; there is no local or offline validation mode
  • Enforces scope-based access control on your API routes
  • Manages connection lifecycle (create, revoke, audit) using your configured storage backend (MongoDB or in-memory)

What the SDK does NOT do

  • Does not transmit raw end-user PII (such as name, email, or device identifiers) - each introspection request sends the opaque access token and your API key
  • Does not perform passive background telemetry or analytics - network calls occur only during active token validation

What the AgentAdmit hosted service records

On every token validation, AgentAdmit's /api/v1/verify endpoint receives the access token and API key, resolves the token to its user_id, connection_id, granted scopes, and agent_label, and records per-call metadata (including the endpoint and timestamp) for billing, audit logging, the security alerts engine, and usage metering. This is integral to how AgentAdmit works and applies to both Test Mode and live keys. See the "Mandatory introspection" notes above and the compliance guide for the full data-handling description.

Privacy impact

Since this SDK runs on your server, it has no direct App Store or Play Store compliance surface. Your client-side integration (e.g., the AgentAdmit React SDK) handles privacy manifest and data safety requirements.

For complete compliance guidance, see our compliance guide.

License

All rights reserved. Patent pending.

Security Alerts

Monitor suspicious agent activity with the AgentAdmit alerts API. Six alert types are supported:

  • volume_spike - unusual request volume
  • failed_scope_attempts - repeated scope access failures
  • burst_pattern - rapid burst of requests
  • stale_reactivation - dormant connection suddenly active
  • new_scope_usage - agent using a scope for the first time
  • revoked_connection_attempt - revoked connection trying to authenticate

Configure Alert Thresholds

from agentadmit import configure_alerts

result = configure_alerts(
    app_id="app_abc123",
    alert_type="volume_spike",
    enabled=True,
    threshold_value=100,
    threshold_window_minutes=5,
    kill_switch_enabled=True,
    kill_switch_threshold_value=500,
    kill_switch_threshold_window_minutes=10,
)
# {"ok": True, "config": {...}}

List Alert Events

from agentadmit import list_alerts

events = list_alerts(app_id="app_abc123", alert_type="volume_spike", limit=50)
# {"events": [...], "total": 12, "limit": 50, "offset": 0}

Get Current Config

from agentadmit import get_alert_config

config = get_alert_config(app_id="app_abc123")
conn_config = get_alert_config(app_id="app_abc123", connection_id="conn_xyz")

Notifying Your Users

AgentAdmit detects anomalies, fires alerts, and (with kill switch) auto-revokes connections. How you notify your own users is up to you. AgentAdmit provides the data - you deliver it through your own system (in-app notifications, email, push, etc.).

  • Poll alerts - Use the SDK methods above from your backend to check for new events, then notify users through your existing system.

  • Webhook delivery - Configure a webhook URL in your AgentAdmit dashboard. When an alert fires, AgentAdmit POSTs the payload to your server, signed with your whsec_... secret. Always verify the signature before trusting the payload:

    from agentadmit import verify_webhook_signature, WebhookSignatureError
    
    @app.post("/agentadmit/alerts")
    async def alerts(request: Request):
        payload = await request.body()
        try:
            verify_webhook_signature(
                payload,
                request.headers.get("X-AgentAdmit-Signature", ""),
                secret=os.environ["AGENTADMIT_WEBHOOK_SECRET"],  # whsec_...
            )
        except WebhookSignatureError:
            return JSONResponse({"error": "invalid_signature"}, status_code=400)
        event = json.loads(payload)
        ...
    

    The header format is t=<unix_ts>,v1=<hex> - an HMAC-SHA256 of {t}.{raw_body} keyed with your signing secret. The helper compares in constant time and rejects timestamps more than 5 minutes off (replay protection).

  • React SDK - Embed the <AlertsPanel> component so users can view their own alert history and tighten thresholds.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

agentadmit-1.4.0.tar.gz (60.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

agentadmit-1.4.0-py3-none-any.whl (52.7 kB view details)

Uploaded Python 3

File details

Details for the file agentadmit-1.4.0.tar.gz.

File metadata

  • Download URL: agentadmit-1.4.0.tar.gz
  • Upload date:
  • Size: 60.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.13

File hashes

Hashes for agentadmit-1.4.0.tar.gz
Algorithm Hash digest
SHA256 d06635ec9d1d929453553fbf7dc3b00d02d08ed39539e30c56eb788fea67879e
MD5 8f751c84c93fc89e178f932de5ab4240
BLAKE2b-256 b15a4a27e915652ff4a1a101d96055570120a860602f1ebab5b2d9239d13abe2

See more details on using hashes here.

Provenance

The following attestation bundles were made for agentadmit-1.4.0.tar.gz:

Publisher: publish.yml on PhoenixCo-Founder/agentadmit-sdk-python

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file agentadmit-1.4.0-py3-none-any.whl.

File metadata

  • Download URL: agentadmit-1.4.0-py3-none-any.whl
  • Upload date:
  • Size: 52.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.13

File hashes

Hashes for agentadmit-1.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 9a2e58a7eec865a4f60cc3b6d209075241ecb238954b1023acb2a7a7826d78e1
MD5 2e98e82da918edd39f2aeb93063370fd
BLAKE2b-256 ad0800fc04264b7bd57ab8a7aff98fe3be7ab58b5f7d69850a6cd9395f4bbabd

See more details on using hashes here.

Provenance

The following attestation bundles were made for agentadmit-1.4.0-py3-none-any.whl:

Publisher: publish.yml on PhoenixCo-Founder/agentadmit-sdk-python

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page