loginWithOtp() - Turnkey

Logs in a user using an OTP verification token.

This function logs in a user using the verification token received after OTP verification (from email or SMS).
If a public key is not provided, a new API key pair will be generated for authentication.
Optionally invalidates any existing sessions for the user if invalidateExisting is set to true.
Stores the resulting session token under the specified session key, or the default session key if not provided.
Handles cleanup of unused key pairs if login fails.

Package: core

Defined in: core.ts:1268

params

object

required

Show params details

params.invalidateExisting

boolean

flag to invalidate existing session for the user.

params.publicKey

string

public key to use for authentication. If not provided, a new key pair will be generated.

params.sessionKey

string

session key to use for session creation (defaults to the default session key).

params.verificationToken

string

required

verification token received after OTP verification.

A successful response returns the following fields:

returns

BaseAuthResult

required

A promise that resolves to a BaseAuthResult, which includes: