@auth0/auth0-react
    Preparing search index...

    Interface 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)
    // 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();
    interface PasskeyApiClient {
        login(options?: PasskeyLoginOptions): Promise<TokenEndpointResponse>;
        signup(options: PasskeySignupOptions): Promise<TokenEndpointResponse>;
    }
    Index

    Methods

    login signup

    Methods

    • 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

      • Optionaloptions: 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

      If WebAuthn is not supported in the browser

      If the challenge request fails

      If the token exchange fails

      If the user cancels the WebAuthn prompt

    • 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

      If WebAuthn is not supported in the browser

      If the challenge request fails

      If the token exchange fails

      If the user cancels the WebAuthn prompt

    Settings

    Member Visibility

    On This Page

    Methods