API reference / @evolu/common / local-first/Public / LocalAuthOptions
Interface: LocalAuthOptions
Defined in: packages/common/src/local-first/LocalAuth.ts:346
Extended by
Properties
| Property | Modifier | Type | Description | Defined in |
|---|---|---|---|---|
accessControl? | readonly | AccessControl | Native: 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/local-first/LocalAuth.ts:364 |
androidBiometricsStrongOnly? | readonly | boolean | Android: Fine tune whether the hardware-authenticated key should require biometrics only. | packages/common/src/local-first/LocalAuth.ts:370 |
authenticationPrompt? | readonly | AuthenticationPrompt | Native: Optional prompt configuration that will be shown when protected keys require user presence. | packages/common/src/local-first/LocalAuth.ts:376 |
iosSynchronizable? | readonly | boolean | IOS: Enable keychain item synchronization via iCloud. | packages/common/src/local-first/LocalAuth.ts:354 |
keychainGroup? | readonly | string | IOS: Custom keychain access group. | packages/common/src/local-first/LocalAuth.ts:357 |
relyingPartyID? | readonly | string | Web: The relying party ID for WebAuthn. Defaults to the current hostname. | packages/common/src/local-first/LocalAuth.ts:379 |
relyingPartyName? | readonly | string | Web: The relying party name for WebAuthn. Defaults to 'Evolu'. | packages/common/src/local-first/LocalAuth.ts:382 |
service? | readonly | string | Native: Namespaces the stored entry. Defaults to the bundle identifier (when available) or default. | packages/common/src/local-first/LocalAuth.ts:351 |
webAuthnAuthenticatorAttachment? | readonly | AuthenticatorAttachment | Web: The authenticator attachment for WebAuthn. Defaults to 'platform'. | packages/common/src/local-first/LocalAuth.ts:394 |
webAuthnUsername? | readonly | string | Web: The username for WebAuthn. Defaults to 'Evolu User'. | packages/common/src/local-first/LocalAuth.ts:385 |
webAuthnUserVerification? | readonly | UserVerificationRequirement | Web: The user verification requirement for WebAuthn. Defaults to 'required'. | packages/common/src/local-first/LocalAuth.ts:391 |