@auth0/nextjs-auth0 - v4.33.0
    Preparing search index...

    Interface PasskeyRegisterOptions

    Options for requesting a passkey signup challenge. Triggers Auth0 POST /passkey/register.

    interface PasskeyRegisterOptions {
        connection?: string;
        deliveryMethod?: PasskeyDeliveryMethod;
        email?: string;
        familyName?: string;
        givenName?: string;
        name?: string;
        nickname?: string;
        onVerificationRequired?: (
            context: PasskeyVerificationContext,
        ) => Promise<Partial<Record<PasskeyVerificationIdentifier, string>>>;
        organization?: string;
        phoneNumber?: string;
        picture?: string;
        userMetadata?: Record<string, string>;
        username?: string;
    }
    Index
    connection? deliveryMethod? email? familyName? givenName? name? nickname? onVerificationRequired? organization? phoneNumber? picture? userMetadata? username?
    connection?: string

    Auth0 database connection name.

    deliveryMethod?: PasskeyDeliveryMethod

    Phone OTP delivery channel. Only relevant when the connection requires phone identifier verification. Omit for email-only verification or when no verification is required.

    email?: string

    User's email address.

    familyName?: string

    User's family (last) name.

    givenName?: string

    User's given (first) name.

    name?: string

    User's full name, shown in the browser passkey dialog.

    nickname?: string

    User's nickname.

    onVerificationRequired?: (
        context: PasskeyVerificationContext,
    ) => Promise<Partial<Record<PasskeyVerificationIdentifier, string>>>

    Browser passkey.signup() only; ignored by the server register().

    Called when the connection requires identifier verification. Resolve with the codes the user entered. It is called before the passkey is created, and again with the remaining identifiers if a code is rejected. The same passkey is resubmitted, so the user is not prompted for it twice.

    Without this callback a signup that requires verification fails with PasskeyGetTokenError code verification_required.

    organization?: string

    Auth0 organization ID.

    phoneNumber?: string

    User's phone number in E.164 format.

    picture?: string

    URL of the user's profile picture.

    userMetadata?: Record<string, string>

    Additional user metadata.

    username?: string

    Username for the new account.

    Settings
    Member Visibility

    On This Page
    Properties