Interface PasswordlessClient

Public interface for the passwordless client. Accessible via auth0.passwordless after initialization.

interface PasswordlessClient {
    challengeWithEmail(
        options: PasswordlessDbChallengeEmailOptions,
    ): Promise<PasswordlessDbChallenge>;
    challengeWithPhoneNumber(
        options: PasswordlessDbChallengePhoneOptions,
    ): Promise<PasswordlessDbChallenge>;
    loginWithOtp(options: PasswordlessDbGetTokenOptions): Promise<void>;
    start(options: PasswordlessStartOptions): Promise<void>;
    verify(options: PasswordlessVerifyOptions): Promise<void>;
}

Index

Methods

challengeWithEmail challengeWithPhoneNumber loginWithOtp start verify

Methods

challengeWithEmail

challengeWithEmail(
options: PasswordlessDbChallengeEmailOptions,
): Promise<PasswordlessDbChallenge>
Request a one-time password for a database connection user identified by email.

Calls POST /otp/challenge and returns an opaque authSession token. The challenge always returns successfully regardless of whether the user exists (user-enumeration prevention). If the user does not exist and allowSignup is false, or if the user is blocked, the returned authSession will be non-functional and loginWithOtp will fail with invalid_request.

A successful response does not guarantee an OTP was delivered.
Parameters
- options: PasswordlessDbChallengeEmailOptions
  Database connection name, email address, and optional signup flag.
Returns Promise<PasswordlessDbChallenge>
- Defined in src/types/passwordless.ts:180

challengeWithPhoneNumber

challengeWithPhoneNumber(
options: PasswordlessDbChallengePhoneOptions,
): Promise<PasswordlessDbChallenge>
Request a one-time password for a database connection user identified by phone number.

Same 200-always contract as challengeWithEmail.
Parameters
- options: PasswordlessDbChallengePhoneOptions
  Database connection name, phone number, optional delivery method, and signup flag.
Returns Promise<PasswordlessDbChallenge>
- Defined in src/types/passwordless.ts:192

loginWithOtp

loginWithOtp(options: PasswordlessDbGetTokenOptions): Promise<void>
Exchange an authSession and user-entered OTP for tokens and establish a session.

Throws PasswordlessDbGetTokenError with error: "invalid_request" if the authSession was non-functional (blocked user, signup disabled for a non-existent user, wrong OTP, or expired session).
Parameters
- options: PasswordlessDbGetTokenOptions
  The authSession from a prior challenge call and the user's OTP.
Returns Promise<void>
- Defined in src/types/passwordless.ts:205

start

start(options: PasswordlessStartOptions): Promise<void>
Starts a passwordless authentication flow by sending an OTP or magic link to the user's email address or phone number.

For magic link (send: 'link') in App Router, the transaction cookie is written via next/headers automatically. In Pages Router, pass explicit req and res so the cookie can be set on the response.
Parameters
- options: PasswordlessStartOptions
  Connection type and user identifier.
Returns Promise<void>
- Defined in src/types/passwordless.ts:158

verify

verify(options: PasswordlessVerifyOptions): Promise<void>
Verifies the OTP entered by the user and establishes an authenticated session.
Parameters
- options: PasswordlessVerifyOptions
  Connection type, user identifier, and OTP code.
Returns Promise<void>
- Defined in src/types/passwordless.ts:165