Abstract
Abstract
usernameSpecifies the username that must be used to authenticate.
IMPORTANT
Providing the username is required.
the username.
the Authentication object.
Abstract
sessionSpecifies the session provider that must be used to authenticate.
the SessionProvider.
the Authentication object.
Abstract
retryThe retry policy to be used to obtain an AuthorizationProvider after the user authenticates successfully. If obtaining an AuthorizationProvider fails on the first try, the SDK will retry according to the provided RetryPolicy. This policy is used when the backend is the Identity Suite and cookies are created after a successful authentication.
the retry policy to be used when retrieving the AuthorizationProvider. By default, the code will retry 3 times with a time interval of 1 second between tries.
the Authentication object.
Abstract
authenticatorSpecifies the object that will take care of the selection of the authenticator to be used.
IMPORTANT
Providing the authenticator selector is required.
the Authentication object.
Abstract
pinSpecifies the object that will take care of the PIN user verification.
IMPORTANT
Providing at least one of the PinUserVerifier, PasswordUserVerifier,
BiometricUserVerifier or DevicePasscodeUserVerifier or FingerprintUserVerifier
is required.
the PinUserVerifier.
the Authentication object.
Abstract
passwordSpecifies the object that will take care of the password user verification.
IMPORTANT
Providing at least one of the PinUserVerifier, PasswordUserVerifier,
BiometricUserVerifier or DevicePasscodeUserVerifier or FingerprintUserVerifier
is required.
the PasswordUserVerifier.
the Authentication object.
Abstract
biometricSpecifies the object that will take care of the biometric user verification.
IMPORTANT
Providing at least one of the PinUserVerifier, PasswordUserVerifier,
BiometricUserVerifier or DevicePasscodeUserVerifier or FingerprintUserVerifier
is required.
the Authentication object.
Abstract
deviceSpecifies the object that will take care of the device passcode user verification.
IMPORTANT
Providing at least one of the PinUserVerifier, PasswordUserVerifier,
BiometricUserVerifier or DevicePasscodeUserVerifier or FingerprintUserVerifier
is required.
the Authentication object.
Abstract
fingerprintSpecifies the object that will take care of the fingerprint user verification.
IMPORTANT
Providing at least one of the PinUserVerifier, PasswordUserVerifier,
BiometricUserVerifier or DevicePasscodeUserVerifier or FingerprintUserVerifier
is required.
the Authentication object.
Abstract
onSpecifies the object that will be invoked if the authentication was successful.
IMPORTANT
Providing the onSuccess is required.
the callback which receives an optional AuthorizationProvider.
Optional
authorizationProvider: AuthorizationProviderthe Authentication object.
Abstract
onSpecifies the object that will be invoked if the authentication failed.
IMPORTANT
Providing the onError is required.
the function which receives an AuthenticationError.
the Authentication object.
Abstract
requestSpecifies the additional request headers that must be included in the HTTP requests sent by the operation.
the HTTP headers.
an HttpOperation object.
Abstract
executeGenerated using TypeDoc
The object that can be used to trigger an authentication operation.
Usage example: