AuthCloudApiRegistration class abstract
The object that can be used to trigger a registration operation from the response to the Authentication Cloud API enroll request.
Usage example:
class AuthenticatorSelectorImpl implements AuthenticatorSelector {
@override
void selectAuthenticator(
AuthenticatorSelectionContext context,
AuthenticatorSelectionHandler handler,
) {
handler.aaid(aaid);
}
}
class BiometricUserVerifierImpl implements BiometricUserVerifier {
@override
void verifyBiometric(
BiometricUserVerificationContext context,
BiometricUserVerificationHandler handler,
) {
handler.verifyBiometric();
}
}
[...]
Future<void> register({
required MobileAuthenticationClient client,
required String enrollResponse,
required DeviceInformation deviceInformation,
}) async {
await client.operations.authCloudApiRegistration
.enrollResponse(enrollResponse)
.deviceInformation(deviceInformation)
.authenticatorSelector(AuthenticatorSelectorImpl(...))
.biometricUserVerifier(BiometricUserVerifierImpl(...))
.onSuccess(() {
// handle success
})
.onError((error) {
// handle error
})
.execute();
}
[...]
The biometric, device passcode and fingerprint authenticators are enrolled at the OS level. That is why, if one of them must be registered, the user must authenticate through BiometricUserVerifier, DevicePasscodeUserVerifier or FingerprintUserVerifier. In the case of the PIN and password, the credentials are enrolled during registration, so no authentication is needed.
- Inheritance
-
- Object
- HttpOperation<
AuthCloudApiRegistration> - AuthCloudApiRegistration
Constructors
Properties
- hashCode → int
-
The hash code for this object.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
allowClass2AndroidSensors(
bool allowClass2AndroidSensors) → AuthCloudApiRegistration - Specifies whether Class 2 (formerly weak) biometric sensors are allowed if the biometric authenticator is selected.
-
allowDevicePasscodeAsFallback(
bool allowDevicePasscodeAsFallback) → AuthCloudApiRegistration - Specifies whether the OS device passcode can be used as fallback during biometric authentication.
-
allowStrongBox(
bool allowStrongBox) → AuthCloudApiRegistration - Specifies whether the SDK should try to store the FIDO UAF keys in StrongBox.
-
appLinkUri(
String appLinkUri) → AuthCloudApiRegistration -
Specifies the value of the
appLinkUriattribute in the enroll response sent by the server. -
authenticatorSelector(
AuthenticatorSelector authenticatorSelector) → AuthCloudApiRegistration - Specifies the object that will take care of the selection of the authenticator to be used.
-
biometricUserVerifier(
BiometricUserVerifier biometricUserVerifier) → AuthCloudApiRegistration - Specifies the object that will take care of the biometric user verification.
-
deviceInformation(
DeviceInformation deviceInformation) → AuthCloudApiRegistration - Specifies the device information to be used.
-
devicePasscodeUserVerifier(
DevicePasscodeUserVerifier devicePasscodeUserVerifier) → AuthCloudApiRegistration - Specifies the object that will take care of the device passcode user verification.
-
enrollResponse(
String enrollResponse) → AuthCloudApiRegistration - Specifies the response to the Authentication Cloud API enroll request.
-
execute(
) → Future< void> -
Executes the operation asynchronously.
inherited
-
fingerprintUserVerifier(
FingerprintUserVerifier fingerprintUserVerifier) → AuthCloudApiRegistration - Specifies the object that will take care of the fingerprint user verification.
-
invalidateOnNewOsBiometrics(
bool invalidateOnNewOsBiometrics) → AuthCloudApiRegistration - Specifies whether the authenticator must be invalidated if the user changes biometric credentials in the OS settings.
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
onError(
dynamic onError(AuthCloudApiError)) → AuthCloudApiRegistration - Specifies the object that will be invoked if the registration failed.
-
onSuccess(
Function onSuccess) → AuthCloudApiRegistration - Specifies the object that will be invoked if the registration completed successfully.
-
passwordEnroller(
PasswordEnroller passwordEnroller) → AuthCloudApiRegistration - Specifies the object that will take care of enrolling the password of the authenticator.
-
pinEnroller(
PinEnroller pinEnroller) → AuthCloudApiRegistration - Specifies the object that will take care of enrolling the PIN of the authenticator.
-
requestHeaders(
RequestHeaders requestHeaders) → AuthCloudApiRegistration -
Specifies the additional request headers that must be included in the HTTP
requests sent by the operation.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited