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