API reference / @evolu/common / Evolu/Public / LocalAuthOptions

Interface: LocalAuthOptions

Defined in: packages/common/src/Evolu/LocalAuth.ts:345

Extended by

Properties

PropertyModifierTypeDescriptionDefined in
accessControl?readonlyAccessControlNative: Desired access-control policy. The native implementation will automatically fall back to the strongest supported policy for the current device (Secure Enclave ➝ Biometry ➝ Device Credential ➝ None).packages/common/src/Evolu/LocalAuth.ts:363
androidBiometricsStrongOnly?readonlybooleanAndroid: Fine tune whether the hardware-authenticated key should require biometrics only.packages/common/src/Evolu/LocalAuth.ts:369
authenticationPrompt?readonlyAuthenticationPromptNative: Optional prompt configuration that will be shown when protected keys require user presence.packages/common/src/Evolu/LocalAuth.ts:375
iosSynchronizable?readonlybooleanIOS: Enable keychain item synchronization via iCloud.packages/common/src/Evolu/LocalAuth.ts:353
keychainGroup?readonlystringIOS: Custom keychain access group.packages/common/src/Evolu/LocalAuth.ts:356
relyingPartyID?readonlystringWeb: The relying party ID for WebAuthn. Defaults to the current hostname.packages/common/src/Evolu/LocalAuth.ts:378
relyingPartyName?readonlystringWeb: The relying party name for WebAuthn. Defaults to 'Evolu'.packages/common/src/Evolu/LocalAuth.ts:381
service?readonlystringNative: Namespaces the stored entry. Defaults to the bundle identifier (when available) or default.packages/common/src/Evolu/LocalAuth.ts:350
webAuthnAuthenticatorAttachment?readonlyAuthenticatorAttachmentWeb: The authenticator attachment for WebAuthn. Defaults to 'platform'.packages/common/src/Evolu/LocalAuth.ts:393
webAuthnUsername?readonlystringWeb: The username for WebAuthn. Defaults to 'Evolu User'.packages/common/src/Evolu/LocalAuth.ts:384
webAuthnUserVerification?readonlyUserVerificationRequirementWeb: The user verification requirement for WebAuthn. Defaults to 'required'.packages/common/src/Evolu/LocalAuth.ts:390

Was this page helpful?