SDK API Reference
Complete reference documentation for all modules and methods in the AuthOS SDK including authentication, user management, organizations, and services.
SDK API Reference
Complete reference documentation for all modules and methods in the AuthOS SDK.
SDK Modules
Authentication & Users
- Auth Module -
sso.auth.*- Login, registration, OAuth, and device flow - User Module -
sso.user.*- User profiles, linked identities, and MFA - Passkeys Module -
sso.passkeys.*- WebAuthn/Passkey management - Magic Links Module -
sso.magicLinks.*- Passwordless authentication
Organizations & Services
- Organizations Module -
sso.organizations.*- Organization management - Permissions Module -
sso.permissions.*- Role-based access control checking - Services Module -
sso.services.*- Service configuration and plans - Invitations Module -
sso.invitations.*- Team member invitations
Platform & Backend
- Platform Module -
sso.platform.*- Platform owner administration - Service API Module -
sso.serviceApi.*- Backend service authentication
Operations & Privacy
- Analytics Module -
sso.analytics.*- Usage metrics and tracking - Privacy Module -
sso.privacy.*- GDPR data export and deletion
Pages
Auth Module
Complete API reference for sso.auth module - OAuth flows, device authentication, token management, and password authentication
User Module
Complete API reference for sso.user module - profile management, identity linking, MFA, and password management
Organizations Module
Complete API reference for sso.organizations module - organization management, members, end-users, audit logs, webhooks, and SCIM.
Passkeys Module
WebAuthn/Passkey authentication methods for passwordless login using biometrics or hardware security keys.
Permissions Module
Permission checking and management methods (ReBAC).
Magic Links Module
Passwordless authentication via magic links sent to email.
Services Module
Complete API reference for sso.services module - service management, subscription plans, API keys, SAML 2.0 Identity Provider, and Billing.
Analytics Module
Complete API reference for sso.analytics module - retrieve login and authentication analytics, track user patterns, and monitor service usage.
Invitations Module
Complete API reference for sso.invitations module - invite users to organizations, manage invitations, accept and decline invitations
Platform Module
Complete API reference for sso.platform module - platform owner administration, organization management, user management, analytics, and audit logs
Service API Module
Complete API reference for sso.serviceApi module - API key authenticated backend operations for user and subscription management
Privacy Module
Complete API reference for sso.privacy module - GDPR compliance, right to access, right to be forgotten