@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 {
        getLoginChallenge(
            options?: PasskeyLoginChallengeOptions,
        ): Promise<PasskeyLoginChallenge>;
        getSignupChallenge(
            options: PasskeySignupChallengeOptions,
        ): Promise<PasskeySignupChallenge>;
        getTokenWithPasskey(
            options: PasskeyGetTokenOptions,
        ): Promise<TokenEndpointResponse>;
        login(options?: PasskeyLoginOptions): Promise<TokenEndpointResponse>;
        signup(options: PasskeySignupOptions): Promise<TokenEndpointResponse>;
    }
    Index
    getLoginChallenge getSignupChallenge getTokenWithPasskey login signup

    • Request a passkey login challenge.

      Step 1 of the granular login flow. Returns the auth session and a decoded PublicKeyCredentialRequestOptions. Run the WebAuthn assertion ceremony with publicKey, then hand the resulting credential and authSession to getTokenWithPasskey().

      Parameters

      • Optionaloptions: PasskeyLoginChallengeOptions

        Optional login challenge options (realm/organization)

      Returns Promise<PasskeyLoginChallenge>

      A promise resolving to { authSession, publicKey }

      If WebAuthn is not supported in the browser

      If the challenge request fails

    • Request a passkey signup challenge.

      Step 1 of the granular signup flow. Returns the auth session and a decoded PublicKeyCredentialCreationOptions. Run the WebAuthn credential creation ceremony with publicKey, then hand the resulting credential and authSession to getTokenWithPasskey().

      Parameters

      • options: PasskeySignupChallengeOptions

        Signup challenge options (user identifier, optional realm/organization/metadata)

      Returns Promise<PasskeySignupChallenge>

      A promise resolving to { authSession, publicKey }

      If WebAuthn is not supported in the browser

      If the challenge request fails

    • Exchange a signed passkey credential for tokens.

      Step 2 of the granular flow. Serializes the raw PublicKeyCredential produced by the WebAuthn ceremony — either a creation (signup) or an assertion (login) credential — and exchanges it for tokens. The credential type (attestation vs assertion) is detected automatically.

      Parameters

      • options: PasskeyGetTokenOptions

        The auth session, raw credential, and optional realm/organization/scope/audience

      Returns Promise<TokenEndpointResponse>

      A promise resolving to the token endpoint response

      If WebAuthn is not supported in the browser

      If the credential is not a valid attestation or assertion response

      If the token exchange fails

    • 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