Interface PasskeyBrowserClient

Browser-side passkey interface — one-call convenience methods. Used by the passkey singleton exported from @auth0/nextjs-auth0/client. Handles challenge fetch, WebAuthn ceremony, and token exchange internally.

interface PasskeyBrowserClient {
    enrollmentChallenge(
        options?: PasskeyEnrollmentChallengeOptions,
    ): Promise<PasskeyEnrollmentChallengeResponse>;
    enrollmentVerify(
        options: PasskeyEnrollmentVerifyOptions,
    ): Promise<PasskeyEnrollmentVerifyResponse>;
    login(options?: PasskeyChallengeOptions): Promise<void>;
    signup(options?: PasskeyRegisterOptions): Promise<void>;
}

Index

Methods

enrollmentChallenge enrollmentVerify login signup

Methods

enrollmentChallenge

enrollmentChallenge(
options?: PasskeyEnrollmentChallengeOptions,
): Promise<PasskeyEnrollmentChallengeResponse>
Request a passkey enrollment challenge for an already-authenticated user. Calls Auth0 MyAccount POST /me/v1/authentication-methods.
Parameters
- Optionaloptions: PasskeyEnrollmentChallengeOptions
  Optional connection or identity user ID.
Returns Promise<PasskeyEnrollmentChallengeResponse>
- Defined in src/types/passkey.ts:383

enrollmentVerify

enrollmentVerify(
options: PasskeyEnrollmentVerifyOptions,
): Promise<PasskeyEnrollmentVerifyResponse>
Verify and complete a passkey enrollment. Calls Auth0 MyAccount POST /me/v1/authentication-methods/{id}/verify.
Parameters
- options: PasskeyEnrollmentVerifyOptions
  Authentication method ID, auth session, and serialised credential.
Returns Promise<PasskeyEnrollmentVerifyResponse>
- Defined in src/types/passkey.ts:393

login(options?: PasskeyChallengeOptions): Promise<void>
Complete a full passkey login in one call. Fetches the challenge, runs navigator.credentials.get(), then exchanges for a session.
Parameters
- Optionaloptions: PasskeyChallengeOptions
  Optional connection or organization.
Returns Promise<void>
- Defined in src/types/passkey.ts:375

signup(options?: PasskeyRegisterOptions): Promise<void>
Complete a full passkey signup in one call. Fetches the challenge, runs navigator.credentials.create(), then exchanges for a session.
Parameters
- Optionaloptions: PasskeyRegisterOptions
  User profile and optional connection/organization.
Returns Promise<void>
- Defined in src/types/passkey.ts:367

Interface PasskeyBrowserClient

Index

Methods

Methods

enrollmentChallenge

Parameters

Returns Promise<PasskeyEnrollmentChallengeResponse>

enrollmentVerify

Parameters

Returns Promise<PasskeyEnrollmentVerifyResponse>

Parameters

Returns Promise<void>

Parameters

Returns Promise<void>

Settings

On This Page