In this guide, we’ll walk through the process of recovering a user using their email.
@turnkey/sdk-server
: Used on the server-side to leverage the parent organization’s public/private API key pair for initializing the email recovery.@turnkey/sdk-browser
: Used on the client-side to complete the email recovery process by adding an end-user passkey.@turnkey/sdk-react
: Used for Next.js applications to initialize the Turnkey SDK.TurnkeyProvider
providing the required configuration options. This allows you to use the Turnkey client throughout your app via the useTurnkey()
hook.NEXT_PUBLIC_ORGANIZATION_ID
should be set to the parent organization ID which can be found in the Turnkey Dashboard.The NEXT_PUBLIC_TURNKEY_RP_ID
should be set to your application’s desired relying party ID; this is typically your domain, or localhost if developing locally. See this page for more details.@turnkey/sdk-server
package. This allows you to use the parent organization’s public/private API key pair to initialize the email recovery process securely.
"use server"
directive at the top of the file where you’re initializing the Turnkey server client. This will ensure that the function is executed on the server-side and will have access to the server-side environment variables e.g. your parent organization’s public/private API key pair. For more information on Next.js server actions, see the Next.js documentation on Server Actions and Mutations.iframeClient
which will create a secure iframe within your application. The iframeClient
must be initialized before beginning the user recovery process, as we’ll need the iframe’s public key as a parameter for the initEmailRecovery
method.
"use client"
directive to the Recovery component to as react hooks can only be used client-side.initEmailRecovery
that will be used to initialize the email recovery process on the server-side. This method will be called from the client-side with the user’s email and the target public key from the iframe client. Calling the initEmailRecovery
method will trigger an email sent to the user containing a credential bundle which will be used to authenticate the authIframeClient in the next step.
initEmailRecovery
server action to be called from the client-side.authIframeClient
via the injectCredentialBundle
method.
Import the server action
Add an input field for the user's email
Create a function to initiate the recovery process
Add an input for the credential bundle
recovery.tsx
Add a function to complete the recovery process
completeRecovery
that will create a new passkey for the user which will be used in the final recovery step.Add a button to call the completeRecovery function
encodedChallenge
and attestation
from the passkey we previously created to the recoverUser
method. This method will complete the email recovery process and if successful, will return a response containing the authenticator ID of the new passkey authenticator.
Complete recovery.tsx component