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

Interface: LocalAuthOptionsValues

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

Extends

Properties

PropertyModifierTypeDescriptionInherited fromDefined 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).LocalAuthOptions.accessControlpackages/common/src/Evolu/LocalAuth.ts:363
androidBiometricsStrongOnly?readonlybooleanAndroid: Fine tune whether the hardware-authenticated key should require biometrics only.LocalAuthOptions.androidBiometricsStrongOnlypackages/common/src/Evolu/LocalAuth.ts:369
authenticationPrompt?readonlyAuthenticationPromptNative: Optional prompt configuration that will be shown when protected keys require user presence.LocalAuthOptions.authenticationPromptpackages/common/src/Evolu/LocalAuth.ts:375
includeValues?readonlybooleanWhen true, the stored value is returned for each item. Defaults to false.-packages/common/src/Evolu/LocalAuth.ts:398
iosSynchronizable?readonlybooleanIOS: Enable keychain item synchronization via iCloud.LocalAuthOptions.iosSynchronizablepackages/common/src/Evolu/LocalAuth.ts:353
keychainGroup?readonlystringIOS: Custom keychain access group.LocalAuthOptions.keychainGrouppackages/common/src/Evolu/LocalAuth.ts:356
relyingPartyID?readonlystringWeb: The relying party ID for WebAuthn. Defaults to the current hostname.LocalAuthOptions.relyingPartyIDpackages/common/src/Evolu/LocalAuth.ts:378
relyingPartyName?readonlystringWeb: The relying party name for WebAuthn. Defaults to 'Evolu'.LocalAuthOptions.relyingPartyNamepackages/common/src/Evolu/LocalAuth.ts:381
service?readonlystringNative: Namespaces the stored entry. Defaults to the bundle identifier (when available) or default.LocalAuthOptions.servicepackages/common/src/Evolu/LocalAuth.ts:350
webAuthnAuthenticatorAttachment?readonlyAuthenticatorAttachmentWeb: The authenticator attachment for WebAuthn. Defaults to 'platform'.LocalAuthOptions.webAuthnAuthenticatorAttachmentpackages/common/src/Evolu/LocalAuth.ts:393
webAuthnUsername?readonlystringWeb: The username for WebAuthn. Defaults to 'Evolu User'.LocalAuthOptions.webAuthnUsernamepackages/common/src/Evolu/LocalAuth.ts:384
webAuthnUserVerification?readonlyUserVerificationRequirementWeb: The user verification requirement for WebAuthn. Defaults to 'required'.LocalAuthOptions.webAuthnUserVerificationpackages/common/src/Evolu/LocalAuth.ts:390

Was this page helpful?