API reference / @evolu/common / local-first/Public / LocalAuthOptionsValues
Interface: LocalAuthOptionsValues
Defined in: packages/common/src/local-first/LocalAuth.ts:397
Extends
Properties
| Property | Modifier | Type | Description | Inherited from | 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). | LocalAuthOptions.accessControl | packages/common/src/local-first/LocalAuth.ts:364 |
androidBiometricsStrongOnly? | readonly | boolean | Android: Fine tune whether the hardware-authenticated key should require biometrics only. | LocalAuthOptions.androidBiometricsStrongOnly | 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. | LocalAuthOptions.authenticationPrompt | packages/common/src/local-first/LocalAuth.ts:376 |
includeValues? | readonly | boolean | When true, the stored value is returned for each item. Defaults to false. | - | packages/common/src/local-first/LocalAuth.ts:399 |
iosSynchronizable? | readonly | boolean | IOS: Enable keychain item synchronization via iCloud. | LocalAuthOptions.iosSynchronizable | packages/common/src/local-first/LocalAuth.ts:354 |
keychainGroup? | readonly | string | IOS: Custom keychain access group. | LocalAuthOptions.keychainGroup | packages/common/src/local-first/LocalAuth.ts:357 |
relyingPartyID? | readonly | string | Web: The relying party ID for WebAuthn. Defaults to the current hostname. | LocalAuthOptions.relyingPartyID | packages/common/src/local-first/LocalAuth.ts:379 |
relyingPartyName? | readonly | string | Web: The relying party name for WebAuthn. Defaults to 'Evolu'. | LocalAuthOptions.relyingPartyName | 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. | LocalAuthOptions.service | packages/common/src/local-first/LocalAuth.ts:351 |
webAuthnAuthenticatorAttachment? | readonly | AuthenticatorAttachment | Web: The authenticator attachment for WebAuthn. Defaults to 'platform'. | LocalAuthOptions.webAuthnAuthenticatorAttachment | packages/common/src/local-first/LocalAuth.ts:394 |
webAuthnUsername? | readonly | string | Web: The username for WebAuthn. Defaults to 'Evolu User'. | LocalAuthOptions.webAuthnUsername | packages/common/src/local-first/LocalAuth.ts:385 |
webAuthnUserVerification? | readonly | UserVerificationRequirement | Web: The user verification requirement for WebAuthn. Defaults to 'required'. | LocalAuthOptions.webAuthnUserVerification | packages/common/src/local-first/LocalAuth.ts:391 |