Type alias Config

Config: {
    AttestationPreference?: ConveyancePreference;
    AuthenticatorSelection?: AuthenticatorSelection;
    Debug?: boolean;
    EncodeUserIDAsString?: boolean;
    RPDisplayName: string;
    RPID: string;
    RPIcon?: string;
    RPOrigin?: string;
    RPOrigins: string[];
    Timeout?: number;
    Timeouts?: TimeoutsConfig;
}

Configuration and default values for the WebAuthn4JS instance.

Type declaration

  • Optional AttestationPreference?: ConveyancePreference

    Preferred attestation conveyance during credential generation

  • Optional AuthenticatorSelection?: AuthenticatorSelection

    Login requirements for authenticator attributes.

  • Optional Debug?: boolean

    Enables various debug options.

  • Optional EncodeUserIDAsString?: boolean

    Ensures the user.id value during registrations is encoded as a raw UTF8 string. This is useful when you only use printable ASCII characters for the random user.id but the browser library does not decode the URL Safe Base64 data.

  • RPDisplayName: string

    Friendly name for the Relying Party (application). The browser may display this to the user.

  • RPID: string

    A valid domain that identifies the Relying Party. A credential can only by used with the same enity (as identified by the RPID) it was registered with.

  • Optional RPIcon?: string

    Deprecated

    This option has been removed from newer specifications due to security considerations.

  • Optional RPOrigin?: string

    Deprecated

    Use RPOrigins instead.

  • RPOrigins: string[]

    Configures the list of Relying Party Server Origins that are permitted. These should be fully qualified origins.

  • Optional Timeout?: number

    Deprecated

    Use Timeouts instead.

  • Optional Timeouts?: TimeoutsConfig

    Configures various timeouts.

Settings

Member Visibility

Theme

Generated using TypeDoc