Authenticate Your UsersOnboarding Modal
Authenticate User via Onboarding Modal
Learn how to trigger and handle authentication using the Okto Onboarding Modal.
Methods Overview
| Method | Description |
|---|---|
showOnboardingModal() | Opens the Okto Onboarding modal with your chosen primaryAuth (e.g., Email, Phone or Google), brand data |
Show Onboarding Modal
async showOnboardingModal() presents a guided onboarding flow to the user. This includes the brand data, theming, and whichever primaryAuth type you’ve set in the <OktoProvider> or pass in at runtime.
Parameters
None directly. The Okto Provider (and its child OnboardingModal.tsx) already know how to handle brandData, primaryAuth, and theme.
Response
Success Response
| Field Name | Type | Description |
|---|---|---|
result | void | No successful response returned |
Note on Brand Customization
You can customize the branding and theming of the onboarding modal by modifying the brandData object in the <OktoProvider> setup. This allows you to define the title, subtitle, and icon that represent your application.