System · IOS API REFERENCE

LocalAuthentication

Authenticate users biometrically or with a passphrase they already know.

28 types

159 callable entries

14 skipped

92% entry coverage

Generated from iOS SDK 27.1. Availability is shown on each declaration; permissions and entitlements still apply.

Types

LAAccessControlOperation

enum · iOS 9.0+

LAAuthenticationRequirement

class · iOS 16.0+

LABiometryFallbackRequirement

class · iOS 16.0+

LABiometryType

enum · iOS 11.0+

LACompanionType

enum · iOS 18.0+

LAContext

class · iOS 8.0+

LAContext.ObjectWillChangePublisher

typealias · iOS 18.0+

LACredentialType

enum · iOS 9.0+

LADomainState

class · iOS 18.0+

LADomainStateBiometry

class · iOS 18.0+

LADomainStateCompanion

class · iOS 18.0+

LAEnvironment

class · iOS 18.0+

LAEnvironment.Mechanism

class · iOS 18.0+

LAEnvironment.MechanismBiometry

class · iOS 18.0+

LAEnvironment.MechanismCompanion

class · iOS 18.0+

LAEnvironment.MechanismUserPassword

class · iOS 18.0+

LAEnvironment.Observer

protocol · iOS 18.0+

LAEnvironment.State

class · iOS 18.0+

LAError

struct · iOS 8.0+

LAError.Code

enum · iOS 8.0+

LAPersistedRight

class · iOS 16.0+

LAPolicy

enum · iOS 8.0+

LAPrivateKey

class · iOS 16.0+

LAPublicKey

class · iOS 16.0+

LARight

class · iOS 16.0+

LARight.State

enum · iOS 16.0+

LARightStore

class · iOS 16.0+

LASecret

class · iOS 16.0+

Functions and constants

get · iOS 8.3+

LAErrorDomain

TypeScript

const LAErrorDomain: string

Swift declaration

let LAErrorDomain: String

get · iOS 9.0+

LATouchIDAuthenticationMaximumAllowableReuseDuration

TypeScript

const LATouchIDAuthenticationMaximumAllowableReuseDuration: number

Swift declaration

let LATouchIDAuthenticationMaximumAllowableReuseDuration: TimeInterval

get

kLAAccessControlOperationCreateItem

TypeScript

const kLAAccessControlOperationCreateItem: number

Swift declaration

var kLAAccessControlOperationCreateItem: Int32 { get }

get

kLAAccessControlOperationCreateKey

TypeScript

const kLAAccessControlOperationCreateKey: number

Swift declaration

var kLAAccessControlOperationCreateKey: Int32 { get }

get

kLAAccessControlOperationUseItem

TypeScript

const kLAAccessControlOperationUseItem: number

Swift declaration

var kLAAccessControlOperationUseItem: Int32 { get }

get

kLAAccessControlOperationUseKeyDecrypt

TypeScript

const kLAAccessControlOperationUseKeyDecrypt: number

Swift declaration

var kLAAccessControlOperationUseKeyDecrypt: Int32 { get }

get

kLAAccessControlOperationUseKeyKeyExchange

TypeScript

const kLAAccessControlOperationUseKeyKeyExchange: number

Swift declaration

var kLAAccessControlOperationUseKeyKeyExchange: Int32 { get }

get

kLAAccessControlOperationUseKeySign

TypeScript

const kLAAccessControlOperationUseKeySign: number

Swift declaration

var kLAAccessControlOperationUseKeySign: Int32 { get }

get

kLABiometryTypeFaceID

TypeScript

const kLABiometryTypeFaceID: number

Swift declaration

var kLABiometryTypeFaceID: Int32 { get }

get

kLABiometryTypeNone

TypeScript

const kLABiometryTypeNone: number

Swift declaration

var kLABiometryTypeNone: Int32 { get }

get

kLABiometryTypeOpticID

TypeScript

const kLABiometryTypeOpticID: number

Swift declaration

var kLABiometryTypeOpticID: Int32 { get }

get

kLABiometryTypeTouchID

TypeScript

const kLABiometryTypeTouchID: number

Swift declaration

var kLABiometryTypeTouchID: Int32 { get }

get

kLACompanionTypeMac

TypeScript

const kLACompanionTypeMac: number

Swift declaration

var kLACompanionTypeMac: Int32 { get }

get

kLACompanionTypeNone

TypeScript

const kLACompanionTypeNone: number

Swift declaration

var kLACompanionTypeNone: Int32 { get }

get

kLACompanionTypeVision

TypeScript

const kLACompanionTypeVision: number

Swift declaration

var kLACompanionTypeVision: Int32 { get }

get

kLACompanionTypeWatch

TypeScript

const kLACompanionTypeWatch: number

Swift declaration

var kLACompanionTypeWatch: Int32 { get }

get

kLACredentialSmartCardPIN

TypeScript

const kLACredentialSmartCardPIN: number

Swift declaration

var kLACredentialSmartCardPIN: Int32 { get }

get

kLACredentialTypeApplicationPassword

TypeScript

const kLACredentialTypeApplicationPassword: number

Swift declaration

var kLACredentialTypeApplicationPassword: Int32 { get }

get

kLAErrorAppCancel

TypeScript

const kLAErrorAppCancel: number

Swift declaration

var kLAErrorAppCancel: Int32 { get }

get

kLAErrorAuthenticationFailed

TypeScript

const kLAErrorAuthenticationFailed: number

Swift declaration

var kLAErrorAuthenticationFailed: Int32 { get }

get

kLAErrorBiometryDisconnected

TypeScript

const kLAErrorBiometryDisconnected: number

Swift declaration

var kLAErrorBiometryDisconnected: Int32 { get }

get

kLAErrorBiometryLockout

TypeScript

const kLAErrorBiometryLockout: number

Swift declaration

var kLAErrorBiometryLockout: Int32 { get }

get

kLAErrorBiometryNotAvailable

TypeScript

const kLAErrorBiometryNotAvailable: number

Swift declaration

var kLAErrorBiometryNotAvailable: Int32 { get }

get

kLAErrorBiometryNotEnrolled

TypeScript

const kLAErrorBiometryNotEnrolled: number

Swift declaration

var kLAErrorBiometryNotEnrolled: Int32 { get }

get

kLAErrorBiometryNotPaired

TypeScript

const kLAErrorBiometryNotPaired: number

Swift declaration

var kLAErrorBiometryNotPaired: Int32 { get }

get

kLAErrorCompanionNotAvailable

TypeScript

const kLAErrorCompanionNotAvailable: number

Swift declaration

var kLAErrorCompanionNotAvailable: Int32 { get }

get

kLAErrorDomain

TypeScript

const kLAErrorDomain: string

Swift declaration

var kLAErrorDomain: String { get }

get

kLAErrorInvalidContext

TypeScript

const kLAErrorInvalidContext: number

Swift declaration

var kLAErrorInvalidContext: Int32 { get }

get

kLAErrorInvalidDimensions

TypeScript

const kLAErrorInvalidDimensions: number

Swift declaration

var kLAErrorInvalidDimensions: Int32 { get }

get

kLAErrorNotInteractive

TypeScript

const kLAErrorNotInteractive: number

Swift declaration

var kLAErrorNotInteractive: Int32 { get }

get

kLAErrorPasscodeNotSet

TypeScript

const kLAErrorPasscodeNotSet: number

Swift declaration

var kLAErrorPasscodeNotSet: Int32 { get }

get

kLAErrorSystemCancel

TypeScript

const kLAErrorSystemCancel: number

Swift declaration

var kLAErrorSystemCancel: Int32 { get }

get

kLAErrorTouchIDLockout

TypeScript

const kLAErrorTouchIDLockout: number

Swift declaration

var kLAErrorTouchIDLockout: Int32 { get }

get

kLAErrorTouchIDNotAvailable

TypeScript

const kLAErrorTouchIDNotAvailable: number

Swift declaration

var kLAErrorTouchIDNotAvailable: Int32 { get }

get

kLAErrorTouchIDNotEnrolled

TypeScript

const kLAErrorTouchIDNotEnrolled: number

Swift declaration

var kLAErrorTouchIDNotEnrolled: Int32 { get }

get

kLAErrorUserCancel

TypeScript

const kLAErrorUserCancel: number

Swift declaration

var kLAErrorUserCancel: Int32 { get }

get

kLAErrorUserFallback

TypeScript

const kLAErrorUserFallback: number

Swift declaration

var kLAErrorUserFallback: Int32 { get }

get

kLAErrorWatchNotAvailable

TypeScript

const kLAErrorWatchNotAvailable: number

Swift declaration

var kLAErrorWatchNotAvailable: Int32 { get }

get

kLAPolicyDeviceOwnerAuthentication

TypeScript

const kLAPolicyDeviceOwnerAuthentication: number

Swift declaration

var kLAPolicyDeviceOwnerAuthentication: Int32 { get }

get

kLAPolicyDeviceOwnerAuthenticationWithBiometrics

TypeScript

const kLAPolicyDeviceOwnerAuthenticationWithBiometrics: number

Swift declaration

var kLAPolicyDeviceOwnerAuthenticationWithBiometrics: Int32 { get }

get

kLAPolicyDeviceOwnerAuthenticationWithBiometricsOrCompanion

TypeScript

const kLAPolicyDeviceOwnerAuthenticationWithBiometricsOrCompanion: number

Swift declaration

var kLAPolicyDeviceOwnerAuthenticationWithBiometricsOrCompanion: Int32 { get }

get

kLAPolicyDeviceOwnerAuthenticationWithBiometricsOrWatch

TypeScript

const kLAPolicyDeviceOwnerAuthenticationWithBiometricsOrWatch: number

Swift declaration

var kLAPolicyDeviceOwnerAuthenticationWithBiometricsOrWatch: Int32 { get }

get

kLAPolicyDeviceOwnerAuthenticationWithCompanion

TypeScript

const kLAPolicyDeviceOwnerAuthenticationWithCompanion: number

Swift declaration

var kLAPolicyDeviceOwnerAuthenticationWithCompanion: Int32 { get }

get

kLAPolicyDeviceOwnerAuthenticationWithWatch

TypeScript

const kLAPolicyDeviceOwnerAuthenticationWithWatch: number

Swift declaration

var kLAPolicyDeviceOwnerAuthenticationWithWatch: Int32 { get }

get

kLAPolicyDeviceOwnerAuthenticationWithWristDetection

TypeScript

const kLAPolicyDeviceOwnerAuthenticationWithWristDetection: number

Swift declaration

var kLAPolicyDeviceOwnerAuthenticationWithWristDetection: Int32 { get }

Skipped declarations

14 declarations were excluded from these bindings. Each reason comes from the generator or the iOS SDK compiler.

LAEnvironment.MechanismCompanion.init()