Package com.thalesgroup.gemalto.d1.authn
Interface D1Authn
public interface D1Authn
Entry point to access the Authn features.
-
Method Summary
Modifier and TypeMethodDescriptionvoidenrollAuthnCredentials(AuthnType preferredAuthnType, D1Task.Callback<Void> callback) Enrols the end user's device for authentication.voidfetchAuthnRequest(D1Task.Callback<Void> callback) Fetches a pending authentication request.Get enrolled authn type.voidunenrollAuthnCredentials(D1Task.Callback<Void> callback) Unenroll the user's device.
-
Method Details
-
getEnrolledAuthnType
Get enrolled authn type. -
enrollAuthnCredentials
void enrollAuthnCredentials(@Nullable AuthnType preferredAuthnType, @NonNull D1Task.Callback<Void> callback) Enrols the end user's device for authentication.- Parameters:
preferredAuthnType- The preferred authn type. IfAuthnType.BIOMETRICis selected and BIOMETRICS are not setup on the device, enroll authentication credential will giveD1Exception.ErrorCode.ERROR_CANCELLEDIfAuthnType.PLATFORMis selected and BIOMETRICS are not setup on the device, enroll authentication credential will fallback to device keyguard IfAuthnType.PLATFORMis selected and BIOMETRICS and keyguard are not setup on the device, enroll authentication credential will giveD1Exception.ErrorCode.ERROR_CANCELLEDcallback- The callback is invoked when the enroll authentication credential process is completed. When it succeeds, the returned argument of theD1Task.Callback.onSuccess(Object)is always null.
Possible errors:
D1Exception.ErrorCode.ERROR_AUTHND1Exception.ErrorCode.ERROR_AUTHN_NOT_ENROLLEDD1Exception.ErrorCode.ERROR_CANCELLEDD1Exception.ErrorCode.ERROR_DEVICE_ENVIRONMENT_UNSAFED1Exception.ErrorCode.ERROR_AUTHN_ACCESS_DENIEDD1Exception.ErrorCode.ERROR_AUTHN_USER_LOCKOUTD1Exception.ErrorCode.ERROR_AUTHN_INVALID_ENROLLMENT_TOKEN
-
unenrollAuthnCredentials
Unenroll the user's device.- Parameters:
callback- The callback invoked when the unenrollment of authn credential process is completed. If device is not enrolled, success callback is invoked.
Possible errors:
- Since:
- 3.1.0
-
-
fetchAuthnRequest
Fetches a pending authentication request.- Parameters:
callback- The callback is invoked when the fetch authn request process is completed. When it succeeds, the returned argument of theD1Task.Callback.onSuccess(Object)is always null.
Possible errors: