Developer Portal

Documentation Index

Fetch the complete documentation index at: https://docs.alterauth.com/llms.txt

Use this file to discover all available pages before exploring further.

​

Getting Started

​

OAuth Provider Setup

​

Add OAuth Apps

1. Go to OAuth Providers → Add Provider
2. Enter credentials from the provider’s console:
   • Client ID
   • Client Secret
   • Redirect URI: Copy the Redirect URI shown on the provider setup page
3. Select the scopes you need
4. Save and activate

​

Provider Consoles

​

Managed Secrets

​

When to Use Managed Secrets

• Internal APIs that require an API key or service token
• Partner APIs that provide static credentials
• SaaS platforms with API key authentication
• Any service where you already have the credentials

​

Setting Up a Managed Secret Provider

​

Using Managed Secrets

# Same method — just use the managed secret's grant_id
response = await vault.request(
    HttpMethod.GET,
    "https://api.internal.com/v1/loyalty/points",
    grant_id="MANAGED_SECRET_GRANT_ID",  # from Developer Portal
)

​

Managing Secrets

• Rotate: Store a new secret value on the same provider — the grant_id stays the same
• Revoke: Delete a stored secret when it’s no longer needed
• Delete Provider: Remove the provider and all its stored secrets

​

Policies for Managed Secrets

​

Custom Schemas

​

Use Cases

• Sync Settings: Which data to sync, how often
• User Preferences: Per-connection configuration
• Metadata: Labels, tags, categories
• Internal Mapping: Link to application database records

​

Creating a Schema

1. Go to Application → Custom Schemas
2. Click Create Schema
3. Use the visual builder to add fields:
   {
     "sync_preferences": {
       "calendar": {
         "enabled": true,
         "frequency": "hourly"
       },
       "email": {
         "enabled": false
       }
     },
     "department": "engineering",
     "cost_center": "CC-001"
   }
   
4. Set field types and validation:
   • Types: string, number, boolean, object, array
   • Validation: required, min/max, enum values
   • Defaults: Set default values
5. Save and apply to connections

​

Using Schema Data

# Custom schema data is set during the OAuth connection flow
# via the Alter Connect session endpoint, then available
# in the Alter Vault dashboard for filtering and management.
#
# The SDK's vault.request() uses a grant_id to look up
# the right connection. Custom schema data enriches
# the grant metadata for your dashboard workflows.

​

Security Policies

​

Policy Rule Types

​

Creating Policies

​

Policy Examples

{
  "time_restrictions": { "business_hours_only": true, "weekdays_only": true, "timezone": "America/New_York" },
  "ip_allowlist": ["203.0.113.0/24"]
}

{
  "time_restrictions": { "weekdays_only": true }
}

​

Policy Evaluation

1. Time restrictions (is it within business hours / a weekday?)
2. IP allowlist (is the client IP in the allowed list?)

​

Fail-Closed Security

​

API Keys

​

Create an API Key

1. Go to Application → API Keys
2. Click Create Key, name it (e.g., “Production Backend”), and choose an expiration
3. Copy and save the key: alter_key_... (shown only once)

​

Security Best Practices

• Backend Only: Never put API keys in frontend code
• Session Tokens: Create temporary tokens for frontend
• Set Expiration: Use 90-day or shorter expiration for production keys
• Name Keys Descriptively: Use descriptive names to track what each key is for
• Environment Variables: Never commit keys to code

​

Connection Management

​

Connections Dashboard

• Filter: By provider, user, date, or custom schema fields
• Search: Find specific users or connections
• Bulk Actions: Update or revoke multiple connections
• Export: Download connection data as CSV

​

Connection Details

• Provider and account info
• Grant ID
• Custom schema data
• Token status and refresh history
• Audit logs of all access

​

Revoke Access

1. Find the grant
2. Click Revoke
3. Choose:
   • Soft Revoke: Mark inactive (can reactivate)
   • Hard Revoke: Delete completely

​

Organizations & Teams

​

Team Management

1. Go to Organization → Team
2. Invite members with roles:
   • Admin: Full access
   • Developer: Manage apps and connections
   • Viewer: Read-only access

​

Multiple Applications

​

Audit Logs

• Filter by event type, provider, user, actor, or date range
• Search for specific connections, users, or AI agents
• Click any entry for full details
• Export as CSV for compliance reporting

​

Monitoring

​

Dashboard Metrics

• Active Connections: Total by provider
• API Usage: Calls per day/month
• Token Refreshes: Automatic refresh count
• Error Rate: Failed requests percentage
• Policy Violations: Blocked requests

​

Alerts

• High error rates
• Policy violations
• Approaching rate limits
• Connection failures

​

Quick Reference

​

Backend Code

from alter_sdk import AlterVault, HttpMethod

vault = AlterVault(
    api_key="alter_key_...",
    caller="my-service",
)

# OAuth: grant_id from your DB (stored when user completed Alter Connect)
grant_id = db.get_grant(user_id="alice", provider="google")
response = await vault.request(
    HttpMethod.GET,
    "https://www.googleapis.com/calendar/v3/calendars/primary/events",
    grant_id=grant_id,
)

# Managed secret: grant_id from Developer Portal (stored in config/env)
response = await vault.request(
    HttpMethod.GET,
    "https://api.internal.com/v1/loyalty/points",
    grant_id=os.environ["LOYALTY_API_GRANT_ID"],
)

​

Frontend Code

// Call YOUR backend to create a session (using API key)
const { session_token } = await fetch('/api/connect/session').then(r => r.json());

// Open OAuth flow (no API key needed)
await alterConnect.open({
    token: session_token,
    onSuccess: (connections) => {
        // Each connection has a grant_id (UUID) — store it in your database
        for (const conn of connections) {
            console.log('Connected!', conn.grant_id, conn.provider);
        }
    }
});

​

Support

• Documentation: docs.alterauth.com
• API Reference: Available in the Developer Portal
• Email: [email protected]
• Status: status.alterauth.com