Amplify Toolbox
    Preparing search index...

    Type Alias WebAuthnOptions

    WebAuthn configuration options for passkey authentication.

    Configure advanced settings for WebAuthn passkey authentication, including the relying party identifier and user verification requirements.

    https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-passkeys.html

    type WebAuthnOptions = {
        relyingPartyId: string;
        userVerification?: "required" | "preferred";
    }
    Index

    Properties

    relyingPartyId userVerification?

    Properties

    relyingPartyId: string

    The relying party identifier (domain) for WebAuthn credentials.

    WARNING: Changing this value after deployment invalidates all existing passkeys. Users will need to re-register their passkeys.

    Supported values:

    • 'AUTO' - Automatically resolves based on deployment context
    • 'localhost' - For local development and testing
    • Custom domain - Your production domain (e.g., 'example.com', 'app.example.com')
    // Automatic resolution
    relyingPartyId: 'AUTO'

    // Custom domain
    relyingPartyId: 'example.com'
    userVerification?: "required" | "preferred"

    User verification requirement for WebAuthn authentication.

    'preferred'

    // Require biometric or PIN verification
    userVerification: 'required'

    // Prefer verification but allow fallback
    userVerification: 'preferred'

    Settings

    Member Visibility

    On This Page

    Properties