getDeviceAuthenticationDetails
🔐 getDeviceAuthenticationDetails
📘 Overview
The getDeviceAuthenticationDetails
API retrieves the list of Local Device Authentication (LDA) methods supported by the device and their configuration status within the SDK.
This information allows the mobile application to:
- Show available authentication modes like Face ID, Biometric, Pattern, etc.
- Enable or disable specific methods using manageDeviceAuthenticationModes`.
- Adjust user login flow based on supported and configured authentication methods.
- This API works only when
AUTH_TYPE
is set toREL_ID_MANUAL_LDA
orREL_ID_PASSWORDLESS
in the Challenge Management section of the Gateway Management Console. - If the LDA is disabled in the system, the fallback is
getPassword
event during login.
🧾 Response Structure
{
"authenticationCapabilities": [
{
"authenticationType": 4,
"isConfigured": 1
},
{
"authenticationType": 3,
"isConfigured": 0
}
],
"error": {
"longErrorCode": 0,
"shortErrorCode": 0,
"errorString": "Success"
}
}
🔢 authenticationType
Mappings
authenticationType
MappingsauthenticationType | Authentication Name | Platform | AUTH_TYPE |
---|---|---|---|
1 | Touch ID | iOS | REL_ID_MANUAL_LDA |
2 | Face ID | iOS | REL_ID_MANUAL_LDA |
3 | Pattern Authentication | Android | REL_ID_MANUAL_LDA |
4 | Biometric Authentication | Android | REL_ID_MANUAL_LDA |
9 | LDA | iOS/Android | REL_ID_PASSWORDLESS |
🔑 Field Descriptions
authenticationType
: Indicates the type of LDA.isConfigured
:1
: LDA is configured and available.0
: LDA is available but not configured.
💻 Code Snippets
React Native
RdnaClient.getDeviceAuthenticationDetails((syncResponse) => {
const details = syncResponse.response;
});
Flutter
final details = await rdnaClient.getDeviceAuthenticationDetails();
Cordova
com.uniken.rdnaplugin.RdnaClient.getDeviceAuthenticationDetails(successCallback, errorCallback, []);
Native iOS
(RDNAError *)getDeviceAuthenticationDetails:(NSArray<RDNADeviceAuthenticationDetails*>**)authModeDetails;
Native Android
RDNAStatus<RDNADeviceAuthenticationDetails[]> status = rdnaClient.getDeviceAuthenticationDetails();
⚠️ 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 |
📲 Developer Notes
- if no LDA is available, do not show LDA toggle screen
- Use this result with
manageDeviceAuthenticationModes
to update user auth preferences.
Updated 2 months ago