Class PasskeyApiClient

Client for Auth0 Passkey operations.

Provides 2 public methods:

  • signup — Register a new user with a passkey (full flow: challenge → WebAuthn → token exchange)
  • login — Sign in with a passkey (full flow: challenge → WebAuthn → token exchange)

Example

// Signup — single call handles everything
const tokens = await auth0.passkey.signup({ email: 'user@example.com' });

// Login — single call handles everything
const tokens = await auth0.passkey.login();

Methods

login signup

Methods

login

  • login(options?): Promise<TokenEndpointResponse>

  • Sign in with an existing passkey.

    Handles the full flow: requests a login challenge, triggers the browser WebAuthn assertion ceremony, serializes the result, and exchanges it for tokens.

    Parameters

    • Optional options: PasskeyLoginOptions

      Optional passkey login options (optional scope/audience/realm/organization)

    Returns Promise<TokenEndpointResponse>

    A promise that resolves to the token endpoint response containing access/ID tokens

    Throws

    If WebAuthn is not supported in the browser

    Throws

    If the challenge request fails

    Throws

    If the token exchange fails

    Throws

    If the user cancels the WebAuthn prompt

signup

  • signup(options): Promise<TokenEndpointResponse>

  • Register a new user with a passkey.

    Handles the full flow: requests a signup challenge, triggers the browser WebAuthn credential creation ceremony, serializes the result, and exchanges it for tokens.

    Parameters

    Returns Promise<TokenEndpointResponse>

    A promise that resolves to the token endpoint response containing access/ID tokens

    Throws

    If WebAuthn is not supported in the browser

    Throws

    If the challenge request fails

    Throws

    If the token exchange fails

    Throws

    If the user cancels the WebAuthn prompt

Settings

Member Visibility

Theme

On This Page

loginsignup