API Reference

Authorization: Bearer YOUR_API_KEY

X-API-Key: YOUR_API_KEY

POST /auth/users

{
  "email": "user@example.com",
  "password": "SecurePassword123!",
  "emailVerified": false,
  "profile": {
    "firstName": "John",
    "lastName": "Doe"
  },
  "metadata": {
    "plan": "pro"
  }
}

{
  "id": "user_xxx",
  "email": "user@example.com",
  "emailVerified": false,
  "status": "PENDING_VERIFICATION",
  "profile": {
    "firstName": "John",
    "lastName": "Doe"
  },
  "createdAt": "2024-01-01T00:00:00.000Z"
}

GET /auth/users

GET /auth/users/{userId}

PATCH /auth/users/{userId}

{
  "profile": {
    "firstName": "Jonathan"
  },
  "metadata": {
    "plan": "enterprise"
  }
}

DELETE /auth/users/{userId}

POST /auth/users/{userId}/block

POST /auth/users/{userId}/unblock

POST /auth/applications

{
  "name": "My App",
  "type": "SPA",
  "redirectUris": ["https://myapp.com/callback"],
  "allowedOrigins": ["https://myapp.com"],
  "grantTypes": ["AUTHORIZATION_CODE", "REFRESH_TOKEN"]
}

GET /auth/applications

GET /auth/applications/{applicationId}

PATCH /auth/applications/{applicationId}

DELETE /auth/applications/{applicationId}

POST /auth/applications/{applicationId}/rotate-secret

GET /auth/users/{userId}/sessions

DELETE /auth/sessions/{sessionId}

DELETE /auth/users/{userId}/sessions

GET /auth/users/{userId}/mfa/factors

POST /auth/users/{userId}/mfa/totp/enroll

{
  "secret": "JBSWY3DPEHPK3PXP",
  "qrCodeUri": "otpauth://totp/MyApp:user@example.com?secret=..."
}

POST /auth/users/{userId}/mfa/totp/verify

{
  "code": "123456"
}

DELETE /auth/users/{userId}/mfa/factors/{factorId}

POST /auth/users/{userId}/mfa/recovery-codes

POST /auth/connections

{
  "name": "Okta SSO",
  "type": "OIDC",
  "provider": "OKTA",
  "config": {
    "issuerUrl": "https://your-domain.okta.com",
    "clientId": "xxx",
    "clientSecret": "xxx"
  },
  "domains": ["acme.com"],
  "jitProvisioning": true
}

{
  "name": "Azure AD SSO",
  "type": "SAML",
  "provider": "AZURE_AD",
  "config": {
    "idpEntityId": "https://sts.windows.net/xxx/",
    "ssoUrl": "https://login.microsoftonline.com/xxx/saml2",
    "idpCertificate": "-----BEGIN CERTIFICATE-----..."
  }
}

GET /auth/connections

GET /auth/connections/{connectionId}

PATCH /auth/connections/{connectionId}

DELETE /auth/connections/{connectionId}

POST /auth/organizations

{
  "name": "Acme Corp",
  "slug": "acme",
  "displayName": "Acme Corporation"
}

GET /auth/organizations

GET /auth/organizations/{organizationId}

PATCH /auth/organizations/{organizationId}

DELETE /auth/organizations/{organizationId}

GET /auth/organizations/{organizationId}/members

POST /auth/organizations/{organizationId}/members

{
  "userId": "user_xxx",
  "role": "MEMBER"
}

DELETE /auth/organizations/{organizationId}/members/{userId}

POST /auth/organizations/{organizationId}/invitations

{
  "email": "newuser@example.com",
  "role": "MEMBER"
}

POST /auth/webhooks

{
  "url": "https://yourapp.com/webhooks/auth",
  "events": ["user.created", "login.success"]
}

GET /auth/webhooks

GET /auth/webhooks/{webhookId}

PATCH /auth/webhooks/{webhookId}

DELETE /auth/webhooks/{webhookId}

GET /auth/webhooks/{webhookId}/deliveries

GET /auth/security/password-policy

PATCH /auth/security/password-policy

GET /auth/security/session-policy

PATCH /auth/security/session-policy

GET /auth/logs

import { Transactional } from '@usetransactional/node';
 
const client = new Transactional({
  apiKey: process.env.TRANSACTIONAL_API_KEY,
});
 
// Users
const user = await client.auth.users.create({ email, password });
const users = await client.auth.users.list({ status: 'ACTIVE' });
 
// Applications
const app = await client.auth.applications.create({ name, type });
 
// MFA
const enrollment = await client.auth.mfa.enrollTotp(userId);
await client.auth.mfa.verifyTotp(userId, { code });
 
// Organizations
const org = await client.auth.organizations.create({ name, slug });
await client.auth.organizations.addMember(orgId, { userId, role });
 
// Webhooks
const webhook = await client.auth.webhooks.create({ url, events });

from usetransactional import Transactional
 
client = Transactional(api_key="your_api_key")
 
# Users
user = client.auth.users.create(email=email, password=password)
users = client.auth.users.list(status="ACTIVE")
 
# Applications
app = client.auth.applications.create(name=name, type=type)
 
# MFA
enrollment = client.auth.mfa.enroll_totp(user_id)
client.auth.mfa.verify_totp(user_id, code=code)
 
# Organizations
org = client.auth.organizations.create(name=name, slug=slug)
client.auth.organizations.add_member(org_id, user_id=user_id, role=role)
 
# Webhooks
webhook = client.auth.webhooks.create(url=url, events=events)