Interface PasskeyClient

Server-side passkey interface — individual step methods for authentication flows. Used by auth0.passkey on the server singleton. Each method maps directly to one Auth0 API call.

interface PasskeyClient {
    challenge(
        options?: PasskeyChallengeOptions,
    ): Promise<PasskeyChallengeResponse>;
    enrollmentChallenge(
        options?: PasskeyEnrollmentChallengeOptions,
    ): Promise<PasskeyEnrollmentChallengeResponse>;
    enrollmentVerify(
        options: PasskeyEnrollmentVerifyOptions,
    ): Promise<PasskeyEnrollmentVerifyResponse>;
    getToken(options: PasskeyGetTokenOptions): Promise<void>;
    register(
        options?: PasskeyRegisterOptions,
    ): Promise<PasskeyRegisterResponse>;
}

Index

Methods

challenge enrollmentChallenge enrollmentVerify getToken register

Methods

challenge

challenge(options?: PasskeyChallengeOptions): Promise<PasskeyChallengeResponse>
Request a WebAuthn credential assertion challenge for login. Calls Auth0 POST /passkey/challenge.
Parameters
- Optionaloptions: PasskeyChallengeOptions
  Optional connection or organization.
Returns Promise<PasskeyChallengeResponse>
Challenge with authSession and authnParamsPublicKey.
- Defined in src/types/passkey.ts:322

enrollmentChallenge

enrollmentChallenge(
options?: PasskeyEnrollmentChallengeOptions,
): Promise<PasskeyEnrollmentChallengeResponse>
Request a WebAuthn credential creation challenge to enroll a new passkey for the currently authenticated user. Calls Auth0 MyAccount POST /me/v1/authentication-methods. Requires an active session.
Parameters
- Optionaloptions: PasskeyEnrollmentChallengeOptions
Returns Promise<PasskeyEnrollmentChallengeResponse>
- Defined in src/types/passkey.ts:341

enrollmentVerify

enrollmentVerify(
options: PasskeyEnrollmentVerifyOptions,
): Promise<PasskeyEnrollmentVerifyResponse>
Complete a passkey enrollment by verifying the WebAuthn attestation. Calls Auth0 MyAccount POST /me/v1/authentication-methods/{id}/verify. Requires an active session.
Parameters
- options: PasskeyEnrollmentVerifyOptions
Returns Promise<PasskeyEnrollmentVerifyResponse>
- Defined in src/types/passkey.ts:350

getToken

getToken(options: PasskeyGetTokenOptions): Promise<void>
Complete a passkey signup or login by exchanging the WebAuthn assertion for an Auth0 session. Calls Auth0 POST /oauth/token with the WebAuthn grant. Session cookie is set automatically by the SDK.
Parameters
- options: PasskeyGetTokenOptions
  authSession from the challenge + serialised credential.
Returns Promise<void>
- Defined in src/types/passkey.ts:333

register

register(options?: PasskeyRegisterOptions): Promise<PasskeyRegisterResponse>
Request a WebAuthn credential creation challenge for a new user signup. Calls Auth0 POST /passkey/register.
Parameters
- Optionaloptions: PasskeyRegisterOptions
  User profile and optional connection/organization.
Returns Promise<PasskeyRegisterResponse>
Challenge with authSession and authnParamsPublicKey.
- Defined in src/types/passkey.ts:313

Interface PasskeyClient

Index

Methods

Methods

challenge

Parameters

Returns Promise<PasskeyChallengeResponse>

enrollmentChallenge

Parameters

Returns Promise<PasskeyEnrollmentChallengeResponse>

enrollmentVerify

Parameters

Returns Promise<PasskeyEnrollmentVerifyResponse>

getToken

Parameters

Returns Promise<void>

register

Parameters

Returns Promise<PasskeyRegisterResponse>

Settings

On This Page