manageDeviceAuthenticationModes
🔐 REL-ID SDK API: manageDeviceAuthenticationModes
manageDeviceAuthenticationModes
📋 Description
The manageDeviceAuthenticationModes
API allows an application to enable or disable a Local Device Authentication (LDA) method — such as biometrics, pattern, or Face ID — after the user is logged in. This is typically used in user settings to customize login preferences.
Upon invocation, the SDK processes the request and responds with the onDeviceAuthManagementStatus
event.
🧾 Parameters
Parameter | Type | Required | Description |
---|---|---|---|
isEnabled | Boolean | ✅ | true to enable, false to disable |
authType | Integer | ✅ | The LDA type to be managed (see table below) |
🔢 Supported authType
Values
authType
ValuesValue | LDA Type | Platform |
---|---|---|
1 | Touch ID | iOS |
2 | Face ID | iOS |
3 | Pattern | Android |
4 | Biometric Authentication | Android |
9 | General LDA | iOS / Android |
💻 Platform Usage Examples
React Native
RdnaClient.manageDeviceAuthenticationModes(true, 4, (response) => {
console.log("LDA status changed:", response);
});
Flutter
await rdnaClient.manageDeviceAuthenticationModes(true, RDNAAuthenticatorType.BIOMETRIC);
Cordova
com.uniken.rdnaplugin.RdnaClient.manageDeviceAuthenticationModes(
() => console.log("Success"),
(err) => console.error("Error", err),
[true, 4]
);
iOS (Objective-C)
[client manageDeviceAuthenticationModes:YES withAuthenticationType:RDNA_LDA_BIOMETRIC];
Android
rdnaClient.manageDeviceAuthenticationModes(true, RDNALDACapabilities.RDNA_LDA_BIOMETRIC);
📬 Expected Event Callback
The SDK will emit onDeviceAuthManagementStatus
to confirm whether the requested operation succeeded or failed.
⚠️ Error Codes
Code | Error Enum | Developer Action |
---|---|---|
404 | RDNA_ERR_ENABLED_LDA_NOT_FOUND_ON_DEVICE | User is activated using password only and device has no biometrics enrolled > user tries to perform LDA toggling flow Ask user to enroll at least one biometric on device and try again |
✅ On Success
- The specified LDA method is updated (enabled/disabled).
- A confirmation event is received with status.
❌ On Failure
- The error callback is triggered.
- Check
onDeviceAuthManagementStatus.error
for details.
Updated 2 months ago