# SuperTokens Core

## Docs

- [Introduction](https://mintlify.wiki/supertokens/supertokens-core/index.md): Open source authentication service providing secure login and session management
- [Architecture](https://mintlify.wiki/supertokens/supertokens-core/architecture.md): Understanding the SuperTokens three-tier architecture and how components interact
- [Quickstart](https://mintlify.wiki/supertokens/supertokens-core/quickstart.md): Get SuperTokens Core running in 5 minutes
- [Configuration](https://mintlify.wiki/supertokens/supertokens-core/configuration.md): Configure SuperTokens Core with config.yaml and environment variables
- [Session Management](https://mintlify.wiki/supertokens/supertokens-core/concepts/sessions.md): Learn how SuperTokens Core manages sessions with access tokens, refresh tokens, and automatic token rotation
- [Multi-Tenancy](https://mintlify.wiki/supertokens/supertokens-core/concepts/multitenancy.md): Build multi-tenant applications with isolated or shared databases, per-tenant configurations, and tenant-scoped authentication
- [User Management](https://mintlify.wiki/supertokens/supertokens-core/concepts/user-management.md): Manage user lifecycles, link accounts across authentication methods, and handle primary users in SuperTokens Core
- [Security Features](https://mintlify.wiki/supertokens/supertokens-core/concepts/security.md): Learn about SuperTokens Core's security architecture including password hashing, token signing, and encryption
- [Email/Password Authentication](https://mintlify.wiki/supertokens/supertokens-core/auth/email-password.md): Traditional email and password authentication with secure password hashing
- [Passwordless Authentication](https://mintlify.wiki/supertokens/supertokens-core/auth/passwordless.md): Passwordless authentication using one-time codes sent via email or SMS
- [Social Login](https://mintlify.wiki/supertokens/supertokens-core/auth/social-login.md): Third-party authentication with popular identity providers
- [OAuth 2.0](https://mintlify.wiki/supertokens/supertokens-core/auth/oauth.md): OAuth 2.0 authorization server and client capabilities
- [Multi-Factor Authentication (MFA)](https://mintlify.wiki/supertokens/supertokens-core/auth/mfa.md): Add an extra layer of security with TOTP-based MFA
- [WebAuthn / Passkeys](https://mintlify.wiki/supertokens/supertokens-core/auth/webauthn.md): Passwordless authentication using biometrics and security keys
- [SAML Integration](https://mintlify.wiki/supertokens/supertokens-core/auth/saml.md): Enterprise SSO with SAML 2.0 identity providers
- [Bulk User Import](https://mintlify.wiki/supertokens/supertokens-core/advanced/bulk-import.md): Import large numbers of users from external systems with support for multiple authentication methods, account linking, and metadata
- [User Roles & Permissions](https://mintlify.wiki/supertokens/supertokens-core/advanced/user-roles.md): Implement role-based access control (RBAC) with hierarchical permissions and multi-tenant role management
- [User Metadata](https://mintlify.wiki/supertokens/supertokens-core/advanced/user-metadata.md): Store and manage custom user attributes with JSON-based metadata storage
- [Active Users Tracking](https://mintlify.wiki/supertokens/supertokens-core/advanced/active-users.md): Track and count active users with automatic timestamp updates and flexible time-based queries
- [JWT Signing & JWKS](https://mintlify.wiki/supertokens/supertokens-core/advanced/jwt.md): Create custom JWTs with RS256 signing, key rotation, and JWKS endpoint for token verification
- [Self-Hosting SuperTokens Core](https://mintlify.wiki/supertokens/supertokens-core/deployment/self-hosting.md): Learn how to self-host SuperTokens Core on your own infrastructure
- [Database Configuration](https://mintlify.wiki/supertokens/supertokens-core/deployment/database-setup.md): Configure PostgreSQL, MySQL, or MongoDB for SuperTokens Core
- [Docker Deployment](https://mintlify.wiki/supertokens/supertokens-core/deployment/docker.md): Deploy SuperTokens Core using Docker and Docker Compose
- [Monitoring and Observability](https://mintlify.wiki/supertokens/supertokens-core/deployment/monitoring.md): Monitor SuperTokens Core with health checks, logging, metrics, and observability tools
- [Core API Overview](https://mintlify.wiki/supertokens/supertokens-core/api/core/overview.md): SuperTokens Core API reference - authentication, endpoints, and error handling
- [Health Check](https://mintlify.wiki/supertokens/supertokens-core/api/core/hello.md): GET /hello - Test SuperTokens Core server connectivity and health
- [Configuration](https://mintlify.wiki/supertokens/supertokens-core/api/core/config.md): GET /config - Retrieve SuperTokens Core configuration file path
- [User Management](https://mintlify.wiki/supertokens/supertokens-core/api/core/users.md): GET /users - List, search, and paginate through users
- [JWKS Public Keys](https://mintlify.wiki/supertokens/supertokens-core/api/core/jwks.md): GET /.well-known/jwks.json - Retrieve public keys for JWT verification
- [Session Management API](https://mintlify.wiki/supertokens/supertokens-core/api/session/overview.md): Overview of session lifecycle, token structure, and session management endpoints
- [Create Session](https://mintlify.wiki/supertokens/supertokens-core/api/session/create.md): Create a new session for a user
- [Verify Session](https://mintlify.wiki/supertokens/supertokens-core/api/session/verify.md): Verify an access token and retrieve session information
- [Refresh Session](https://mintlify.wiki/supertokens/supertokens-core/api/session/refresh.md): Refresh session tokens to extend session lifetime
- [Revoke Session](https://mintlify.wiki/supertokens/supertokens-core/api/session/revoke.md): Revoke sessions by session handle or user ID
- [Email Password API](https://mintlify.wiki/supertokens/supertokens-core/api/emailpassword/overview.md): API endpoints for email/password authentication
- [Sign Up](https://mintlify.wiki/supertokens/supertokens-core/api/emailpassword/signup.md): Create a new user with email and password
- [Sign In](https://mintlify.wiki/supertokens/supertokens-core/api/emailpassword/signin.md): Sign in a user with email and password
- [Password Reset](https://mintlify.wiki/supertokens/supertokens-core/api/emailpassword/reset-password.md): Generate and consume password reset tokens
- [Passwordless Authentication](https://mintlify.wiki/supertokens/supertokens-core/api/passwordless/overview.md): API endpoints for passwordless authentication with email or phone
- [Create Passwordless Code](https://mintlify.wiki/supertokens/supertokens-core/api/passwordless/create-code.md)
- [Consume Passwordless Code](https://mintlify.wiki/supertokens/supertokens-core/api/passwordless/consume-code.md)
- [Resend Passwordless Code](https://mintlify.wiki/supertokens/supertokens-core/api/passwordless/resend-code.md): Generate a new code for an existing authentication attempt
- [Third Party (Social Login) Overview](https://mintlify.wiki/supertokens/supertokens-core/api/thirdparty/overview.md): Social authentication APIs for signing in users with third-party providers
- [Sign In / Sign Up](https://mintlify.wiki/supertokens/supertokens-core/api/thirdparty/signin-up.md): POST /recipe/signinup - Authenticate users with third-party social providers
- [Provider Configuration](https://mintlify.wiki/supertokens/supertokens-core/api/thirdparty/providers.md): Managing third-party OAuth provider configurations
- [OAuth 2.0 Provider Overview](https://mintlify.wiki/supertokens/supertokens-core/api/oauth/overview.md): SuperTokens OAuth 2.0 provider implementation
- [Authorization Endpoint](https://mintlify.wiki/supertokens/supertokens-core/api/oauth/authorize.md): OAuth 2.0 authorization endpoint
- [Token Endpoint](https://mintlify.wiki/supertokens/supertokens-core/api/oauth/token.md): OAuth 2.0 token endpoint for issuing and refreshing tokens
- [OAuth Client Management](https://mintlify.wiki/supertokens/supertokens-core/api/oauth/clients.md): Create, update, retrieve, and list OAuth clients
- [Multi-tenancy API Overview](https://mintlify.wiki/supertokens/supertokens-core/api/multitenancy/overview.md): Manage apps and tenants in SuperTokens
- [Tenant Management](https://mintlify.wiki/supertokens/supertokens-core/api/multitenancy/tenants.md): Create, update, and manage tenants in SuperTokens
- [App Management](https://mintlify.wiki/supertokens/supertokens-core/api/multitenancy/apps.md): Create, update, and manage apps in SuperTokens
- [Get User by ID](https://mintlify.wiki/supertokens/supertokens-core/api/users/get-by-id.md): Retrieve user information by user ID
- [Delete User](https://mintlify.wiki/supertokens/supertokens-core/api/users/delete.md): Delete a user and optionally all linked accounts
- [List Users](https://mintlify.wiki/supertokens/supertokens-core/api/users/list.md): Get a paginated list of users with filtering and search
- [Account Linking](https://mintlify.wiki/supertokens/supertokens-core/api/users/account-linking.md): Link and unlink user accounts across authentication methods
- [User Roles API Overview](https://mintlify.wiki/supertokens/supertokens-core/api/roles/overview.md): Manage user roles and permissions in SuperTokens
- [Create Role](https://mintlify.wiki/supertokens/supertokens-core/api/roles/create.md): Create a new role or modify its permissions
- [Assign Role to User](https://mintlify.wiki/supertokens/supertokens-core/api/roles/assign.md): Assign a role to a user in a specific tenant
- [Get User Metadata](https://mintlify.wiki/supertokens/supertokens-core/api/metadata/get.md): Retrieve metadata for a specific user
- [Update User Metadata](https://mintlify.wiki/supertokens/supertokens-core/api/metadata/update.md): Create or update metadata for a specific user
- [TOTP/MFA API Overview](https://mintlify.wiki/supertokens/supertokens-core/api/totp/overview.md): Manage time-based one-time password (TOTP) devices for multi-factor authentication
- [Create TOTP Device](https://mintlify.wiki/supertokens/supertokens-core/api/totp/create-device.md): Register a new TOTP device for a user
- [Verify TOTP Device](https://mintlify.wiki/supertokens/supertokens-core/api/totp/verify-device.md): Verify a newly created TOTP device with a valid code
- [Verify TOTP Code](https://mintlify.wiki/supertokens/supertokens-core/api/totp/verify-totp.md): Verify a TOTP code for user authentication
- [WebAuthn API Overview](https://mintlify.wiki/supertokens/supertokens-core/api/webauthn/overview.md): WebAuthn (Web Authentication) API endpoints for passwordless authentication using FIDO2 credentials
- [WebAuthn Registration](https://mintlify.wiki/supertokens/supertokens-core/api/webauthn/register.md): Endpoints for WebAuthn credential registration and signup
- [WebAuthn Authentication](https://mintlify.wiki/supertokens/supertokens-core/api/webauthn/authenticate.md): Endpoints for WebAuthn credential authentication and sign-in
- [WebAuthn Credential Management](https://mintlify.wiki/supertokens/supertokens-core/api/webauthn/credentials.md): Endpoints for managing WebAuthn credentials
- [SAML API Overview](https://mintlify.wiki/supertokens/supertokens-core/api/saml/overview.md): SAML SSO API endpoints for enterprise authentication
- [SAML Client Configuration](https://mintlify.wiki/supertokens/supertokens-core/api/saml/clients.md): Endpoints for managing SAML client configurations
- [SAML Login Initiation](https://mintlify.wiki/supertokens/supertokens-core/api/saml/login.md): Endpoint for initiating SAML authentication flow
- [SAML Assertion Callback](https://mintlify.wiki/supertokens/supertokens-core/api/saml/callback.md): Endpoint for handling SAML assertion callback from IdP
- [Dashboard API Overview](https://mintlify.wiki/supertokens/supertokens-core/api/dashboard/overview.md): Dashboard user authentication and session management API endpoints
- [Dashboard Sessions](https://mintlify.wiki/supertokens/supertokens-core/api/dashboard/sessions.md): Endpoints for managing dashboard user sessions
- [Dashboard User Management](https://mintlify.wiki/supertokens/supertokens-core/api/dashboard/users.md): Endpoints for managing dashboard users
- [Bulk Import API Overview](https://mintlify.wiki/supertokens/supertokens-core/api/bulkimport/overview.md): Bulk user import API endpoints for migrating users to SuperTokens
- [Bulk Import Users](https://mintlify.wiki/supertokens/supertokens-core/api/bulkimport/import.md): Endpoints for adding users to bulk import queue
- [Bulk Import Status](https://mintlify.wiki/supertokens/supertokens-core/api/bulkimport/status.md): Endpoints for checking bulk import status and progress

## OpenAPI Specs

- [openapi](https://mintlify.wiki/supertokens/supertokens-core/api-reference/openapi.json)