Auth Components
Choose the native SDK guide for each authentication flow
- Stable unknown
- Release candidate since 1.16.1-rc.3
- Development since 1.16.1-dev.2111+9796905
The auth module provides UI and hooks for sign-in, registration, password
recovery, profile editing, and session management. Its client-backed components
use the native Ovok client from the nearest OvokProvider from
@ovok/core/next/react. Your app owns routes,
post-auth navigation, and the policies that determine who may sign in or edit
an account.
Choose a guide
| Feature | What it covers |
|---|---|
| Sign-in | Email and password, Google and Apple sign-in, MFA verification, and screen composition |
| Registration | Account creation, registration form components, and examples |
| Password reset | Password recovery form and its component parts |
| Profile form | Editing the signed-in user's Patient profile |
| Session management | Current profile state and server-side sessions |
| Logout button | Ending the current authenticated session |
| Delete account button | Confirming account deletion and handling its result |
| Auth hooks and rate limits | Session hooks and rate-limit helpers for custom forms |
Each guide links to the component-level reference for its form parts and props. You can also open any feature from the Auth Components sidebar section.
Integration model
Mount auth components below the providers described in the app shell guide.
Built-in forms submit through the active client. When you supply a custom
onSubmit, that handler replaces the component's default request and session
behavior; the host app must provide those pieces itself.
Keep the tenant code in public app configuration and pass it to the native
client. It is client-visible configuration, not a credential. If a form still
accepts tenantCode, use the same value as the client. Configure Google and Apple native packages
only when the app offers those providers; see the installation guide.
Next steps
- Follow the authentication integration guide to connect routes, callbacks, MFA, and account controls.
- Use the public API map to find the auth exports.
Last updated on