# IdentityAuthenticationType

Dictionary passed to authenticate.

Availability

0.8

Extends

Object

NOTE

This is an abstract type. Any object of this structure can be used where this type is used.

# Properties

# allowableReuseDuration

Availability

6.1.0

allowableReuseDuration :Number

Note: This property is iOS only!

The time interval (in seconds) for accepting a successful Touch ID / Face ID device unlock (on the lock screen) from the past. If the device was successfully unlocked by Touch ID / Face ID within this time interval, then the biometric authentication on this context will succeed automatically and the reply block will be called without prompting user for authentication.

The default value is 0, meaning that no previous TouchID unlock can be reused.

This property is meant only for reusing biometric matches from the device lock screen. It does not allow reusing previous biometric matches in application or between applications.

The maximum supported interval is 5 minutes and setting the value beyond 5 minutes does not increase the accepted interval.

# callback

Availability

0.8

callback :Callback

Callback function executed after the authentication completes. The callback function is passed a dictionary with three properties:

success (Boolean): Set to true if authentication succeeded.
error (String): System error message.
code (Number): Module ERROR_* constant indicating the reason for the failure.

# cancelTitle

Availability

6.1.0

cancelTitle :String

Note: This property is iOS only!

Allows cancel button title customization. A default localized title "Cancel" is used when this property is not defined or is set to empty string.

# fallbackTitle

Availability

6.1.0

fallbackTitle :String

Note: This property is iOS only!

Allows fallback button title customization. A default localized title "Enter Password" is used when this property is left nil. If set to empty string, the button will be hidden.

# keepAlive

Availability

7.0.0

keepAlive :Boolean

Note: This property is iOS only!

Determines whether the auth-context should be kept alive after authorizing with the TouchID-API and can be used to automatically terminate an auth-context after authorizing.

Please note that calling invalidate will not be possible unless you have a valid auth-context, so you would decide whether to use invalidate to invalidate the context and release the auth-instance or use the keepAlive property inside authenticate to only terminate the context.

Terminated contexts cannot be recovered and will be recreated with a new auth-context once authenticate is called again.

# reason

Availability

0.8

reason :String

Note: This property is iOS only!

Message displayed in the authentication dialog describing why the application is requesting authentication.