Expand description
Built-in plugins and their configuration.
Modules§
- access
- Public access-control utilities matching Better Auth’s resource and action rules.
- account_
management - admin
- anonymous
- Anonymous accounts and their cleanup when a proven account replaces them.
- api_key
- bearer
- Bearer authentication through the ordinary signed session-cookie lifecycle.
- captcha
- CAPTCHA admission before endpoint parsing and authentication side effects.
- custom_
session - Application-owned asynchronous session response projection.
- device_
authorization - email_
otp - Passwordless email authentication and verification using single-use codes.
- email_
password - email_
verification - haveibeenpwned
- Compromised-password policy at initialized password hashing.
- helpers
- Shared helpers for plugin implementations.
- jwt
- Asymmetric session JWTs, public JWKS, and trusted server-side signing.
- last_
login_ method - Remember successful session issuance without changing authentication authority.
- magic_
link - Single-use mailbox authentication links, with native delivery callbacks.
- metadata
- Built-in endpoint and model declarations owned by the feature crate.
- multi_
session - Browser-local selection and revocation of several authenticated accounts.
- oauth
- oauth_
popup - Popup OAuth entry and callback delivery, paired with the official popup client.
- oauth_
proxy - OAuth code exchange on a production host, followed by stateful completion on the originating preview host with database or authenticated cookie state.
- oauth_
token_ conversion - Explicit administrative conversion of pre-Source native OAuth token rows.
- one_tap
- Google One Tap authentication with verified Google ID tokens.
- one_
time_ token - Short-lived, single-use credentials that hand an existing session to a client.
- open_
api OpenAPIschema generation and Scalar reference page.- organization
- passkey
- password_
management - phone_
number - Phone ownership verification, password login and scoped password reset.
- session_
management - siwe
- Sign in with Ethereum using a single-use challenge and application-owned signature verification, including contract-wallet RPC providers.
- two_
factor - user_
management
Structs§
- Account
Management Plugin - Account management plugin for listing and unlinking user accounts.
- Admin
Banned User Message Handler - Cloneable, type-checked application callback configuration.
- Admin
Config - Configuration for the admin plugin.
- Admin
Plugin - Admin plugin for user management operations.
- Anonymous
Config - Anonymous
Link - Both authenticated accounts involved in an anonymous account upgrade.
- Anonymous
Plugin - ApiKey
Callback Context - Immutable application context for trusted API-key lookup and validation.
- ApiKey
Config - Configuration for the API Key plugin, aligned with the TypeScript
ApiKeyOptions. - ApiKey
Generation Options - Inputs passed to an application key generator; length excludes the prefix.
- ApiKey
Plugin - API Key management plugin.
- Bearer
Config - Configuration of the bearer-to-cookie adapter.
- Bearer
Plugin - Captcha
Config - Captcha
Plugin - Change
Email Config - Configuration for the change-email feature.
- Custom
Session Plugin - Replace GET session responses while retaining core authentication and cookies.
Register before an explicitly installed
SessionManagementPluginso this plugin owns the GET route. The replacement accepts GET only, including when deferred refresh is enabled. - Delete
Expired ApiKeys Response - Result of trusted forced expiration cleanup. Store failures are logged.
- Delete
User Config - Configuration for the delete-user feature.
- Device
Authorization Plugin - OAuth 2.0 device authorization grant plugin.
- Email
OtpConfig - Configuration for email OTP verification, login, password reset and email change.
- Email
OtpPlugin - Email
Password Config - Email
Password Plugin - Email and password authentication plugin
- Email
Verification Config - Email
Verification Plugin - Email verification plugin for handling email verification flows
- HaveI
Been Pwned Config - Published enabled, exact-path and compromised-message settings.
- HaveI
Been Pwned Plugin - Installs a password hash policy; it contributes no HTTP routes.
- Last
Login Method Config - Last
Login Method Context - Request context retained at the actual adapter or completed-response boundary.
- Last
Login Method Plugin - Magic
Link Config - Magic
Link Plugin - Multi
Session Config - Number of distinct accounts retained in this browser’s signed cookies.
- Multi
Session Plugin - OAuth
Plugin - OAuth
Popup Plugin - Starts a popup in its first-party auth context and delivers callback results
to the trusted opener. Register alongside
super::oauth::OAuthPluginandsuper::BearerPluginfor embedded clients. - OAuth
Proxy Config - Immutable application configuration.
- OAuth
Proxy Plugin - OneTap
Config - OneTap
Plugin - Open
ApiConfig - Open
ApiPlugin - Organization
Config - Configuration for the Organization plugin
- Organization
Create Patch - Supported fields merged over the validated draft without revalidation.
- Organization
Created Context - Persisted row snapshots used after adding the creator and after creation. The latter callback runs after default-team callbacks and before selection.
- Organization
Draft Context - The validated draft after creation policies and the initial slug check.
- Organization
Member Create Patch - Trusted member-field overrides. The source generates member IDs itself.
- Organization
Member Draft Context - The actual creator-member draft and the organization already persisted.
- Organization
Plugin - Organization plugin for multi-tenancy support
- Passkey
Authentication Config - Passkey
Authentication Context - Immutable request and application settings. Captures may hold typed services.
- Passkey
Authenticator Selection - Passkey
Config - Passkey
Options Context - Passkey
Plugin - Passkey /
WebAuthnauthentication plugin. - Passkey
Registration Config - Passkey
Registration Context - Immutable request and application settings; captures may hold typed services. A captured store is not automatically rebound to the registration transaction.
- Passkey
Registration Override - Passkey
Registration User - Password
Management Config - Password
Management Plugin - Password management plugin for password reset and change functionality
- Phone
Number Config - Phone
Number Plugin - Pwned
Password Client - HTTP range service. Its endpoint is trusted application configuration; requests contain only five uppercase SHA-1 characters, never the password.
- Role
Permissions - Role-based permission grants for the admin plugin.
- Session
Management Plugin - Session management plugin for handling session operations
- Siwe
Config - SIWE application policies. A verifier is required because contract-wallet verification and chain-specific RPC access are owned by the application.
- Siwe
Plugin - TwoFactor
Config - Public configuration for the two-factor plugin.
- TwoFactor
Plugin - Two-factor authentication plugin providing TOTP, OTP, and backup code flows.
- User
Management Config - Combined configuration for the
UserManagementPlugin. - User
Management Plugin - User self-service management plugin (change email & delete account).
- Verified
Passkey Authentication - Actual verifier result, supplied only after the signed assertion succeeds.
- Verified
Passkey Registration - Facts supplied after the requested registration protocol and attestation policy verifies. None attestation admits a credential without proving key possession.
Enums§
- ApiKey
Error Message - Upstream verification messages can contain either text or an error-code object.
- Authentication
Result - Verification authority: Core verifies supported typed keys; the bounded raw verifier verifies original COSE facts without manufacturing a Core result.
- Captcha
Provider - OneTap
Client Id - Google client IDs accepted as the ID-token audience.
- Passkey
Extensions - TwoFactor
Backup Storage - Backup persistence policy. Encrypted storage is the pinned default.
- TwoFactor
OtpStorage - Persistence format for delivered two-factor OTPs.
Traits§
- Admin
Banned User Message - Resolves the message returned when a nonexpired banned user requests a session.
- Anonymous
Identity - Application-owned generation of anonymous display names and email addresses.
- ApiKey
Default Permissions - Trusted dynamic defaults, evaluated even when creation supplies an override.
- ApiKey
Generator - Trusted custom secret generation. The application owns the returned full key.
- ApiKey
Getter - Application lookup replaces configured API-key headers entirely.
- ApiKey
Validator - Trusted acceptance predicate, evaluated before key usage is consumed.
- Before
Store Last Login Method Cookie - Cookie consent does not decide whether the authenticated session may persist.
- Link
Anonymous Account - Transfer application-owned data before the anonymous account is deleted.
- OAuth
Jwks Source - Application-owned key transport/cache. Request claims never choose its URL.
- Organization
Creation Hooks - Creation hooks are awaited at their individual source phases.
- Passkey
Authentication After Verification - Awaited before counter persistence and session creation. The client data is untrusted application input; it cannot replace the verified credential owner.
- Passkey
Extensions Resolver - Passkey
Registration After Verification - Passkey
User Resolver - Resolve an authorized registration identity when no session is available.
- Password
Hasher - Custom password hasher trait for pluggable password hashing strategies.
- Resolve
Last Login Method - A synchronous application resolver.
Nonefalls back to the built-in resolver; an empty string suppresses tracking. Errors propagate at the invoking boundary. - Send
Change Email Confirmation - Custom callback for sending change-email confirmation emails.
- Send
Email Otp - Delivers a code to its intended mailbox with the real native callback context. Delivery awaits and propagates errors by default; configured background work owns its context and logs failures while retaining the issued verification.
- Send
Magic Link - Send
Phone Otp - Send
Reset Password - Trait for sending password reset emails.
- Send
TwoFactor Otp - Callback used by the two-factor plugin to deliver a one-time password.
- Send
Verification Email - Trait for custom email sending logic.
- Session
Transform - Project an authenticated session response into application response data.
- TwoFactor
Backup Cipher - Async persistence callbacks for the complete backup-code JSON string.
- TwoFactor
OtpCipher - Application-owned reversible OTP representation.
- TwoFactor
OtpHasher - Application-owned irreversible OTP representation.
Type Aliases§
- ApiKey
Permissions - Ordered resource/action permissions, following JavaScript object insertion order.
- Email
Verification Hook - Shorthand for the async hook closure type used by
EmailVerificationConfig::before_email_verificationandEmailVerificationConfig::after_email_verification.