FuturaeClient
Properties
Functions
Activate the biometric authentication as a means of convenience to verify the user presence, so that the user doesn't have to enter the PIN to unlock the SDK. This method shall only be called when the SDK LockConfigurationType is SDK_PIN_WITH_BIOMETRICS_OPTIONAL.
Approve an online QR Code authentication session which has extra_info. This is a protected operation, so the SDK must be unlocked before calling this method.
Approve an authentication session using the userId and sessionId. This is a protected operation, so the SDK must be unlocked before calling this method.
Approve an authentication session using the userId, sessionId and MultiNumberedChallenge. This is a protected operation, so the SDK must be unlocked before calling this method.
Approve an authentication session which has extra_info, using the userId and sessionId. This is a protected operation, so the SDK must be unlocked before calling this method.
Approve an authentication session which has extra_info, using the userId, sessionId and multi number challenge response. This is a protected operation, so the SDK must be unlocked before calling this method.
Approve a usernameless QR Code authentication session with optional extra_info. This is a protected operation, so the SDK must be unlocked before calling this method.
Change the Custom App PIN. This is a protected operation, so the SDK must be unlocked before calling this method.
Check for MigrateableAccounts, which contains all information around Account Migration from backup.
Generate the 6-digit OTP that the user needs to enter in the browser when authenticating with the offline QR Code Factor. This is a protected operation, so the SDK must be unlocked before calling this method.
Generates the 6-digit OTP that the user needs to enter in the browser when authenticating with the offline QR Code Factor, when the user presence is verified using the Custom App PIN. This method with the argument sdkPin shall only be used when the SDK LockConfigurationType is SDK_PIN_WITH_BIOMETRICS_OPTIONAL.
Function that generates the 6-digit OTP that the user needs to enter in the browser when authenticating with the offline QR Code Factor, when the user presence is going to be verified using the biometrics. Before calling this function, it should be confirmed that the user has biometrics enabled by using the function getActiveUnlockMethods. This method is only available when the SDK LockConfigurationType is SDK_PIN_WITH_BIOMETRICS_OPTIONAL.
Deactivate biometrics as an authentication method. This function revokes the biometric authentication capability for unlocking the SDK. This method shall only be called when the SDK LockConfigurationType is SDK_PIN_WITH_BIOMETRICS_OPTIONAL
Delete the account identified by the provided user id from the SDK.
Standard enroll function, for which the app does not provide an SDK PIN. It needs to be used for all lock configuration types, with the only exception being that the first enrollment for the SDK_PIN_WITH_BIOMETRICS_OPTIONAL lock configuration type needs to take place by using the enrollAndSetupSDKPin function.
Unlocking function that enrolls the user and unlocks the SDK upon success. This method shall only be used on the first enrollment, if the device has no accounts enrolled beforehand. For subsequent enrollments, the enroll method shall be used instead. This function is only available when the SDK LockConfigurationType is set as SDK_PIN_WITH_BIOMETRICS_OPTIONAL.
Standard enroll function with a provided activation short code instead of a QR code, for which the app does not provide an SDK PIN. It needs to be used for all lock configuration types, with the only exception being that the first enrollment for the SDK_PIN_WITH_BIOMETRICS_OPTIONAL lock configuration type needs to take place by using the enrollAndSetupSDKPin function.
Unlocking function that enrolls the user with an activation shortcode and unlocks the SDK upon success. This method shall only be used on the first enrollment, if the device has no accounts enrolled beforehand. For subsequent enrollments, the enroll method shall be used instead. This function is only available when the SDK LockConfigurationType is set as SDK_PIN_WITH_BIOMETRICS_OPTIONAL.
Execute Account Migration. This is a protected operation, so the SDK must be unlocked before calling this method, for the BIOMETRICS_ONLY and BIOMETRICS_OR_DEVICE_CREDENTIALS lock configuration types.
This is a protected operation, so the SDK must be unlocked before calling this method, for the BIOMETRICS_ONLY and BIOMETRICS_OR_DEVICE_CREDENTIALS lock configuration types. For SDK_PIN_WITH_BIOMETRICS_OPTIONAL this operation is unprotected and unlocks the SDK upon success.
Get the FTAccount identified by the provided user id and device id in the SDK, if it exists
Get Account history for given userIds
Get accounts statuses for given userIds.
Returns the list of available UnlockMethodType which the SDK may currently be unlocked with.
Decrypt push notification extras under the "extra_info_enc" field of the notification payload. This method requires SDK to be unlocked or configured with LockConfigurationType == LockConfigurationType.NONE
Extra Session extra_info from QR code.
Get the FTAccount identified by the provided user id in the SDK, if it exists.
Operation to get an IntegrityResult about the integrity of the app, app-license and device.
Returns the provided QR code type.
Extract Session token from QR code.
Get the session token based on a provided auth URI.
Returns the JWT for synchronous authentication, for the provided user id.
Extract the User Id from a QR code.
Get the user id based on a provided auth URI.
Operation that handles URIs for enroll or authentication. If the URI cannot be handled, this method will return an error via the provided callback This is a protected operation, so the SDK must be unlocked before calling this method.
Unlocking function that checks whether the device biometrics have changed. This method is only available when the SDKConfiguration uses setInvalidatedByBiometricChange(true) and LockConfigurationType other than NONE.
SDK unprotected function returning true if the SDK has already uploaded the public key to futurae servers. if you encounter FTApiInvalidPublicKeyException, call uploadPublicKey even if this function returns true.
Logout the user and remove the account. This is a protected operation, so the SDK must be unlocked before calling this method.
Returns the current 6 digit used in the TOTP offline authentication, for the provided user id. This is a protected operation, so the SDK must be unlocked before calling this method.
Returns the current 6 digit used in the TOTP offline authentication, for the provided user id. This method is only available when the SDK LockConfigurationType is SDK_PIN_WITH_BIOMETRICS_OPTIONAL.
Returns the current 6 digit used in the TOTP offline authentication, for the provided user id. Before calling this function, it should be confirmed that the user has biometrics enabled by using the function getActiveUnlockMethods. This method is only available when the SDK LockConfigurationType is SDK_PIN_WITH_BIOMETRICS_OPTIONAL.
Register push notifications token.
Reject an online QR Code authentication session. This is a protected operation, so the SDK must be unlocked before calling this method.
Reject an authentication session using the userId and sessionId. This is a protected operation, so the SDK must be unlocked before calling this method.
Reject an authentication session which has extra_info, using the userId and sessionId. This is a protected operation, so the SDK must be unlocked before calling this method.
Approve a usernameless QR Code authentication session with optional extra_info. This is a protected operation, so the SDK must be unlocked before calling this method.
Get SessionInfo for a given userId and sessionId. This is a protected operation, so the SDK must be unlocked before calling this method.
Get SessionInfo for given userId and sessionToken. This is a protected operation, so the SDK must be unlocked before calling this method.
Unlocking method that could be called prior to using a locked functionality, when the SDK LockConfigurationType is BIOMETRICS_ONLY or SDK_PIN_WITH_BIOMETRICS_OPTIONAL. This will display a biometric prompt to authenticate the user and the SDK will be unlocked if the verification is successful. Only biometrics classified as androidx.biometric.BiometricManager.Authenticators.BIOMETRIC_STRONG are supported.
Unlocking method that should be called prior to using a locked functionality, when the SDK LockConfigurationType is BIOMETRICS_OR_DEVICE_CREDENTIALS. This will display a biometric prompt (or other device-credential authentication) to authenticate the user and depending on its result will unlock the SDK.
Unlocking method that could be called prior to using a locked functionality, when the SDK LockConfigurationType is SDK_PIN_WITH_BIOMETRICS_OPTIONAL. This will unlock the SDK with the Custom App PIN set during the enrollment. The app needs to implement the relevant mechanism to ask the user to provide the Custom App PIN and then invoke this function.
SDK unprotected function to re-upload the SDK's public key to Futurae servers. Call this method if you encounter FTApiInvalidPublicKeyException