nevis_mobile_authentication_sdk_platform_interface
library
Classes
-
Account
-
The object representing a user account.
-
AccountSelectionContext
-
The service returning the information required to choose the account to be
used.
-
AccountSelectionHandler
-
The objects consuming the outcome of an interaction where the user chooses
the account to be used.
-
AccountSelector
-
The object in charge of selecting an account.
-
AccountUsernameMessage
-
Holds the parameters of the account selection operation platform channel call.
-
AndroidMetaData
-
The object containing information about Nevis Mobile Authentication SDK for
Android.
-
AppAttestation
-
The configuration related to application attestation.
-
AuthCloudApiAppAttestationError
-
The server requires application attestation and there was a problem either
obtaining the application attestation information from the Google Cloud APIs,
or the server did not accept the contents sent by the SDK.
-
AuthCloudApiClockSkewTooBig
-
The clocks on the mobile and on the server are too apart and the server refused
to validate the JWS.
-
AuthCloudApiDecryptionError
-
The encrypted contents of the Auth Cloud API response could not be decrypted.
-
AuthCloudApiDeviceProtectionError
-
An error that indicates that some form of tampering was found in the application.
-
AuthCloudApiError
-
An error occurred during auth cloud api registration.
-
AuthCloudApiFidoError
-
An error that indicates that a FIDO UAF error occurred during an operation.
-
AuthCloudApiMalformedPayload
-
A problem with the provided Auth Cloud API response occurred.
-
AuthCloudApiNetworkError
-
A network error occurred while redeeming the token: either the server was not
reachable or it returned an HTTP error.
-
AuthCloudApiNoDeviceLockError
-
The device has no secure lock screen.
-
AuthCloudApiRegistrationMessage
-
Holds the parameters of the registration operation platform channel call.
-
AuthCloudApiRegistrationPlatformOperation
-
Helps in following the states of auth cloud api registration operations
during method channel calls.
-
AuthCloudApiServerCanceledOperation
-
The error that occurs when the server canceled the operation.
-
AuthCloudApiTokenAlreadyRedeemed
-
The token was already redeemed.
-
AuthCloudApiTokenExpired
-
The token has expired.
-
AuthCloudApiUnknownError
-
Unknown operation error, handling not categorized error cases.
-
AuthCloudApiUserAlreadyRegisteredInAnotherServer
-
An error that occurs with registration when we try to register a new
authenticator in a server for a given username, and there is an authenticator
already registered in another server for that username.
-
AuthenticationAppAttestationError
-
The server requires application attestation and there was a problem either
obtaining the application attestation information from the Google Cloud APIs,
or the server did not accept the contents sent by the SDK.
-
AuthenticationDeviceProtectionError
-
An error that indicates that some form of tampering was found in the application.
-
AuthenticationError
-
An extension of MobileAuthenticationClientError for the
Authentication operation.
-
AuthenticationFidoError
-
An error that indicates that a FIDO UAF error occurred during an operation.
-
AuthenticationMessage
-
Holds the parameters of the authentication operation platform channel call.
-
AuthenticationNetworkError
-
A network error occurred while redeeming the token: either the server was not
reachable or it returned an HTTP error.
-
AuthenticationNoDeviceLockError
-
The device has no secure lock screen.
-
AuthenticationPlatformOperation
-
Helps in following the states of authentication operations during method
channel calls.
-
AuthenticationServerCanceledOperation
-
The error that occurs when the server canceled the operation.
-
AuthenticationUnknownError
-
Unknown error, handling not categorized error cases.
-
Authenticator
-
An object describing an authenticator.
-
AuthenticatorAaidMessage
-
Holds the parameters of the authenticator selection operation platform channel
call.
-
AuthenticatorSelectionContext
-
The service returning the information required to choose the authenticator to
be used.
-
AuthenticatorSelectionContextNames
-
The authenticator selection context method names.
-
AuthenticatorSelectionHandler
-
The objects consuming the outcome of an interaction where
the user chooses the authenticator to be used.
-
AuthenticatorSelector
-
The object in charge of selecting the authenticator to be used to perform an
operation.
-
AuthorizationProvider
-
Provides the authorization elements required to perform protected operations.
-
BiometricPromptOptions
-
Defines the elements of the biometric prompt (title, description and cancel button text).
-
BiometricUserVerificationContext
-
The object providing information about the biometric user verification
(i.e. the user credential validation) operation to be done.
-
BiometricUserVerificationHandler
-
The objects consuming the outcome of an interaction where the user provides
biometric credentials.
-
BiometricUserVerifier
-
The object in charge of interacting with the user to do biometric authentication.
-
CancellableHandler
-
The interface that operation or user interaction handlers are derived from.
-
ChangePasswordMessage
-
Holds the parameters of the password change platform channel call.
-
ChangePasswordPlatformOperation
-
Helps in following the states of password change operations during method
channel calls.
-
ChangePinMessage
-
Holds the parameters of the PIN change platform channel call.
-
ChangePinPlatformOperation
-
Helps in following the states of pin change operations during method channel
calls.
-
ChannelMethodNames
-
The method names that are used for platform channel call.
-
Configuration
-
The Mobile Authentication Client configuration.
-
ConfigurationAdmin4PatternBuilder
-
A simplified builder that can be used to configure an SDK when your application
works with the Identity Suite configured with default Nevis Admin 4 pattern.
-
ConfigurationAuthCloudBuilder
-
A simplified builder that can be used to configure an SDK when your application
works with the Nevis Authentication Cloud.
-
ConfigurationBuilder
-
A builder for Configuration.
-
ConstantRetryPolicy
-
The operation will be retried periodically with a maximum number of tries.
-
CookieAuthorizationProvider
-
An HTTP cookie based authorization provider.
-
CookieContainer
-
A container that holds a cookie and an uri that belongs to the cookie.
-
CookieSessionProvider
-
An HTTP cookie based session provider.
-
DeleteAuthenticatorError
-
The error which is thrown by
LocalData.deleteAuthenticator in case of any
error occurs. For instance if the provided AAID is not known, or if an error
occurred during deleting the associated FIDO UAF credentials.
-
DeleteAuthenticatorInvalidAaidError
-
Invalid AAID were provided during authenticator deletion.
-
DeleteAuthenticatorMessage
-
Holds the parameters of the authenticator deletion operation platform channel
call.
-
DeleteAuthenticatorUnknownError
-
Unknown error, handling not categorized error cases.
-
DeregistrationMessage
-
Holds the parameters of the deregistration operation platform channel call.
-
DeregistrationPlatformOperation
-
Helps in following the states of deregistration operations during method
channel calls.
-
DeviceCapabilitiesMethodNames
-
The metaData method names.
-
DeviceCapabilitiesPlatformInterface
-
Holds device capabilities related platform calls.
-
DeviceInformation
-
The object containing information of the device where the SDK is running.
-
DeviceInformationChangeClockSkewTooBig
-
The clocks on the mobile and on the server are too apart and the server refused
to validate the JWS.
-
DeviceInformationChangeDeviceProtectionError
-
An error that indicates that some form of tampering was found in the application.
-
DeviceInformationChangeError
-
The error that can occur with operations related to a DeviceInformation.
-
DeviceInformationChangeMessage
-
Holds the parameters of the device information change operation platform
channel call.
-
DeviceInformationChangeNameAlreadyExists
-
There is already a device information with the provided name. All the device
information names of a given user must be unique.
-
DeviceInformationChangeNetworkError
-
A network error occurred.
-
DeviceInformationChangeNoDeviceLockError
-
The device has no secure lock screen.
-
DeviceInformationChangeNotFound
-
The device information to be updated could not be found.
-
DeviceInformationChangePlatformOperation
-
Helps in following the states of device information change operations during
method channel calls.
-
DeviceInformationChangeUnknownError
-
Unknown device information change error, handling not categorized error cases.
-
DeviceInformationCheckClockSkewTooBig
-
The clocks on the mobile and on the server are too apart and the server refused
to validate the JWS.
-
DeviceInformationCheckDeviceProtectionError
-
An error that indicates that some form of tampering was found in the application.
-
DeviceInformationCheckError
-
The error that can occur with operations related to a
DeviceInformationCheck.
-
DeviceInformationCheckForbidden
-
An error that indicates that the SDK could not access the credentials in the
backend.
-
DeviceInformationCheckMessage
-
Holds the parameters of the device information check platform channel call.
-
DeviceInformationCheckNetworkError
-
A network error occurred.
-
DeviceInformationCheckNoDeviceLockError
-
The device has no secure lock screen.
-
DeviceInformationCheckOperationNotSupportedByBackend
-
The backend does not support the retrieval of credentials.
-
DeviceInformationCheckPlatformOperation
-
Helps in following the states of device information check during method
channel calls.
-
DeviceInformationCheckResult
-
This is the result of the
DeviceInformationCheck operation.
-
DeviceInformationCheckUnknownError
-
Unknown device information check error, handling not categorized error cases.
-
DeviceInformationMismatch
-
The configuration mismatches between the server and the mobile device application.
-
DeviceInformationSyncClockSkewTooBig
-
The clocks on the mobile and on the server are too apart and the server refused
to validate the JWS.
-
DeviceInformationSyncDeviceProtectionError
-
An error that indicates that some form of tampering was found in the application.
-
DeviceInformationSyncError
-
The error that can occur with operations related to a
DeviceInformationSync.
-
DeviceInformationSyncMessage
-
Holds the parameters of the device information sync platform channel call.
-
DeviceInformationSyncNetworkError
-
A network error occurred.
-
DeviceInformationSyncNoDeviceLockError
-
The device has no secure lock screen.
-
DeviceInformationSyncOperationNotSupportedByBackend
-
The backend does not support the sync of credentials.
-
DeviceInformationSyncPlatformOperation
-
Helps in following the states of device information sync during method channel
calls.
-
DeviceInformationSyncResult
-
This is the result of the
DeviceInformationSync operation.
-
DeviceInformationSyncUnknownError
-
Unknown device information sync error, handling not categorized error cases.
-
DeviceNameMismatch
-
There is a mismatch between the name of the device in the server and the one
in the mobile device application.
-
DevicePasscodePromptOptions
-
Defines the elements of the device passcode prompt (title and description).
-
DevicePasscodeUserVerificationContext
-
The object providing information about the device passcode user verification
(i.e. the user credential validation) operation to be done.
-
DevicePasscodeUserVerificationHandler
-
The objects consuming the outcome of an interaction where the user provides
device passcode credentials.
-
DevicePasscodeUserVerifier
-
The object in charge of interacting with the user to do device passcode authentication.
-
EmptySuccessResponse
-
Represents an empty success callback.
-
ExponentialRetryPolicy
-
The operation will be retried at exponential intervals.
-
FcmRegistrationTokenMismatch
-
There is a mismatch between the firebase registration token in the server and
the one in the mobile device application.
-
FidoErrorCode
-
Error class indicating that a problem during a FIDO UAF operation occurred.
-
FidoUafAttestationInformation
-
The interface informing about whether the device supports
Full Basic attestation.
-
FidoUafAttestationInformationCertificateError
-
There was an unexpected error retrieving the certificate information from the device. If
this error happens, it should be assumed that only basic surrogate attestation is supported
by the device.
-
FidoUafAttestationInformationError
-
An error occurred during obtaining the FIDO UAF attestation information.
-
FidoUafAttestationInformationFetchCrlError
-
The Certificate Revocation List (CRL) published by Google
with the revoked attestation certificates could not be retrieved.
-
FidoUafAttestationInformationMessage
-
Holds the parameters of the FIDO UAF attestation information platform
channel call.
-
FidoUafAttestationInformationPlatformOperation
-
Helps in following the states of FIDO UAF attestation information operations
during method channel calls.
-
FidoUafAttestationInformationUnknownError
-
Unknown attestation information error, handling not categorized error cases.
-
FingerprintPromptOptions
-
Defines the elements of the fingerprint prompt (description, cancel and
fallback button texts).
-
FingerprintUserVerificationContext
-
The object providing information about the fingerprint user verification
(i.e. the user credential validation) operation to be done.
-
FingerprintUserVerificationError
-
The recoverable error that can occur when verifying the user with fingerprint.
-
FingerprintUserVerificationHandler
-
The objects consuming the outcome of an interaction where the user provides
fingerprint credentials.
-
FingerprintUserVerifier
-
The object in charge of interacting with the user to do fingerprint authentication.
-
IdUsernamePair
-
The DeviceInformation is stored a set of generic credentials representing
dispatch targets in nevisIDM. For each account there is a generic credential
in nevisIDM. This object exposes the value of the
Identification attribute
of each of the generic credentials for each account.
-
InitClientMessage
-
Holds the parameters of the client initialization platform channel call.
-
InitializationDeviceProtectionError
-
An error that indicates that some form of tampering was found in the application.
-
InitializationError
-
Collection of
MobileAuthenticationClient initialization error codes.
-
InitializationHardwareError
-
Secure hardware is not available on this device or an error occurred checking
the hardware of the device.
-
InitializationLockScreenHasChangedError
-
User has changed the lock screen configuration of the device and the credentials
were created using an SDK previous to 1.7. The data no longer accessible.
This happens for example when the user created fingerprint redentials with an
application using an SDK previous to 1.7 and the fingerprints were modified.
On credentials created with an SDK 1.7 or later, changing the screen lock protection
does not result in this error.
-
InitializationNoDeviceLockError
-
The error that occurs when the device has no secure lock screen during initialization.
-
InitializationPlatformOperation
-
Helps in following the states of initialization operation during method
channel calls.
-
InitializationProtectedDataUnavailableError
-
An error that indicates that protected data is not available at the time of SDK
initialization.
-
InitializationRootedError
-
The device is rooted. The SDK cannot be run in rooted devices.
For security reasons, the SDK will remove the credentials in this device when
this is detected.
-
InitializationUnknownError
-
Unknown error, handling not categorized error cases.
-
IosMetaData
-
The object containing information about Nevis Mobile Authentication SDK for iOS.
-
IsPolicyCompliantMessage
-
Holds the parameters of the operation platform channel call.
-
JwsAuthorizationProvider
-
An authorization provider using JWS
to do the authorization.
-
JwtAuthorizationProvider
-
A JWT based authorization provider.
-
JwtSessionProvider
-
A JWT based session provider.
-
ListenForOsCredentialsMessage
-
Holds the parameters of the out-of-band operation platform channel call.
-
LocalDataMethodNames
-
The local data method names.
-
LocalDataPlatformInterface
-
Holds local data related platform calls.
-
MetaDataMethodNames
-
The meta data method names.
-
MetaDataPlatformInterface
-
Holds meta data related platform calls.
-
MethodChannelMethodCallHandler
-
Method call handler to handle incoming method calls.
-
MissingAuthenticatorInMobileDevice
-
An authenticator is registered in the server for an account, but not in the
mobile device application.
-
MissingAuthenticatorInServer
-
An authenticator is registered in the mobile device application for an account,
but not in the server.
-
MissingDeviceInformationInMobileDevice
-
The device information for the given IdUsernamePair is defined in the server
but not in the mobile device application.
-
MissingDeviceInformationInServer
-
The device information for the given IdUsernamePair is defined in the SDK
but not in the server.
-
MobileAuthenticationClientError
-
The parent of all the errors that can be returned.
-
NevisMobileAuthenticationSdkPlatform
-
Base class that defines the common SDK platform.
-
NoRetryPolicy
-
Retry policy to do not retry: in case of failure the operation will report
the error without retrying.
-
OnlyDefaultMode
-
The device supports the
default full basic attestation mode as described in
the nevisFIDO documentation.
-
OnlySurrogateBasicSupported
-
Only the surrogate basic attestation is supported.
-
OobAuthenticationMessage
-
Holds the parameters of the out-of-band authentication operation platform
channel call.
-
OobOperationMessage
-
Holds the parameters of the out-of-band operation platform channel call.
-
OobPayloadDecodeMessage
-
Holds the parameters of the out-of-band payload decode platform channel call.
-
OobRegistrationMessage
-
Holds the parameters of the out-of-band registration operation platform channel
call.
-
OperationAppAttestationError
-
The server requires application attestation and there was a problem either
obtaining the application attestation information from the Google Cloud APIs,
or the server did not accept the contents sent by the SDK.
-
OperationClockSkewTooBig
-
The clocks on the mobile and on the server are too apart and the server refused
to validate the JWS.
-
OperationDeviceProtectionError
-
An error that indicates that some form of tampering was found in the application.
-
OperationError
-
An error occurred during registration or deregistration.
-
OperationFidoError
-
An error that indicates that a FIDO UAF error occurred during an operation.
-
OperationIdMessage
-
Holds the parameters of the out-of-band operation platform channel call.
-
OperationNetworkError
-
A network error occurred while redeeming the token: either the server was not
reachable or it returned an HTTP error.
-
OperationNoDeviceLockError
-
The device has no secure lock screen.
-
OperationNotSupportedByBackend
-
The backend does not support using the JwsAuthorizationProvider.
-
OperationServerCanceledOperation
-
The error that occurs when the server canceled the operation.
-
OperationSigningFailedWithStrongBox
-
The device supports StrongBox and the key was created and stored in StrongBox
during registration, but the created key cannot be used for signing.
In this case the registration fails and the created key material is deleted.
-
OperationsPlatformInterface
-
Holds operations platform calls.
-
OperationUnknownError
-
Unknown operation error, handling not categorized error cases.
-
OperationUserAlreadyRegisteredInAnotherServer
-
An error that occurs with registration when we try to register a new
authenticator in a server for a given username, and there is an authenticator
already registered in another server for that username.
-
OperationUserNotRegisteredInServer
-
An error that occurs with username-less out-of-band authentication, if the username of
a registered account is provided to the AccountSelectionHandler, but the user
is not defined in the server where the token was redeemed.
-
OsAuthenticationListenHandler
-
An object that can be used to pause or resume listening for OS credentials
(i.e. fingerprint, face recognition) and to cancel the whole operation while
listening for credentials.
-
OsAuthenticationListenHandlerNames
-
The OS authentication listen handler method names.
-
OsAuthenticationListenHandlerPlatformInterface
-
Holds os authentication related platform calls.
-
OsUserEnrollment
-
The object containing the user enrollment information for an authenticator
whose credentials are managed by the operating system (like the fingerprint
authenticator).
-
OutOfBandAuthenticationPlatformOperation
-
Helps in following the states of out-of-band authentication operations
during method channel calls.
-
OutOfBandOperationDeviceProtectionError
-
An error that indicates that some form of tampering was found in the application.
-
OutOfBandOperationError
-
The error that can occur when the processing of an OutOfBandPayload fails.
-
OutOfBandOperationNetworkError
-
A network error occurred while redeeming the token: either the server was not
reachable or it returned an HTTP error.
-
OutOfBandOperationNoDeviceLockError
-
The device has no secure lock screen.
-
OutOfBandOperationServerCanceledOperation
-
The error that occurs when the server canceled the operation.
-
OutOfBandOperationTokenAlreadyRedeemed
-
The token was already redeemed.
-
OutOfBandOperationTokenExpired
-
The token has expired.
-
OutOfBandOperationUnknownError
-
Unknown out-of-band operation error, handling not categorized error cases.
-
OutOfBandPayload
-
This object describes the contents that are sent by nevisFIDO in the out-of-band
use case to start an operation (registration, authentication or deregistration).
-
OutOfBandPayloadDecodePlatformOperation
-
Helps in following the states of out-of-band payload decode operation during
method channel calls.
-
OutOfBandPayloadDecryptionError
-
The encrypted contents of the out-of-band payload could not be decrypted.
-
OutOfBandPayloadDeviceProtectionError
-
An error that indicates that some form of tampering was found in the application.
-
OutOfBandPayloadError
-
The error returned when there is a problem with the out-of-band payload:
it cannot be decrypted or the provided JSON is not properly formatted.
-
OutOfBandPayloadMalformedPayload
-
A violation of the out-of-band payload (contents of OutOfBandPayload) occurred.
-
OutOfBandPayloadNoDeviceLockError
-
The device has no secure lock screen.
-
OutOfBandPayloadUnknownError
-
Unknown out-of-band payload error, handling not categorized error cases.
-
OutOfBandPlatformOperation
-
Helps in following the states of out-of-band operations during method channel
calls.
-
OutOfBandRegistrationPlatformOperation
-
Helps in following the states of out-of-band registration operations during
method channel calls.
-
PasswordAuthenticatorProtectionStatus
-
The object describing the password authenticator protection status.
-
PasswordChangeContext
-
The object providing some contextual information during password change.
-
PasswordChangeDeviceProtectionError
-
An error that indicates that some form of tampering was found in the application
during password change.
-
PasswordChangeError
-
The error returned when the password change failed.
-
PasswordChangeHandler
-
The object handling the old and new password provided by the end-user.
-
PasswordChangeNoDeviceLockError
-
The error that occurs when the device has no secure lock screen during a
password change.
-
PasswordChangePasswordLocked
-
The error that occurs when the password was locked because of too many failures.
-
PasswordChangePasswordNotEnrolled
-
The error that occurs when the specified user during a password change operation
does not have an enrolled password.
-
PasswordChanger
-
The object in charge of password change.
-
PasswordChangeRecoverableCustomValidationError
-
The provided password has failed the validation done in PasswordPolicy.validatePasswordForPasswordChange.
-
PasswordChangeRecoverableError
-
The recoverable error that can occur when changing a password.
-
PasswordChangeRecoverableInvalidPassword
-
The provided old password is not valid.
-
PasswordChangeRecoverableOldPasswordEqualsNewPassword
-
The old and new password are equal. The new password must be different than
the old password.
-
PasswordChangeUnknownError
-
Unknown password change error, handling not categorized error cases.
-
PasswordChangeUserCanceled
-
The error that occurs when the password change was cancelled.
-
PasswordChangeUserNotResponsive
-
The error that occurs when the user took too long to provide the password during the change operation.
-
PasswordEnroller
-
The object in charge of password enrollment.
-
PasswordEnrollmentContext
-
The object providing some contextual information during password enrollment.
-
PasswordEnrollmentCustomValidationError
-
The provided password has failed the validation done in PasswordPolicy.validatePasswordForEnrollment.
-
PasswordEnrollmentError
-
The object that informs that an error occurred during password enrollment.
-
PasswordEnrollmentHandler
-
The object handling the password to be enrolled.
-
PasswordMessage
-
Holds the parameters of the pin operation platform channel call.
-
PasswordPolicy
-
The object defining whether the password provided by a user during enrollment
or when changing is valid.
-
PasswordPolicyImpl
-
Default implementation for PasswordPolicy.
-
PasswordPolicyProvider
-
An object defining the PasswordPolicy.
-
PasswordProtectionStatusLastAttemptFailed
-
An invalid password was provided previously.
-
PasswordProtectionStatusLockedOut
-
The authenticator is locked and cannot be used.
-
PasswordProtectionStatusUnlocked
-
The authenticator is unlocked and can be used.
-
PasswordsMessage
-
Holds the parameters of the password change operation platform channel call.
-
PasswordUserVerificationContext
-
The object providing information about the password user verification
(i.e. the user credential validation) operation to be done.
-
PasswordUserVerificationHandler
-
The objects consuming the outcome of an interaction where the user provides
password credentials.
-
PasswordUserVerifier
-
The object in charge of interacting with the user to do password authentication.
-
PasswordValidatedMessage
-
Holds the parameters of the password validation platform channel call.
-
PendingOobOperationsMessage
-
Holds the parameters of the pending out-of-band operations platform channel call.
-
PendingOutOfBandOperation
-
The object defining a non-redeemed out-of-band operation as defined in the
Get Device Out-of-Band Operations
service.
-
PendingOutOfBandOperationsClockSkewTooBig
-
The clocks on the mobile and on the server are too apart and the server refused
to validate the JWS.
-
PendingOutOfBandOperationsDeviceProtectionError
-
An error that indicates that some form of tampering was found in the application.
-
PendingOutOfBandOperationsError
-
The error that can occur with the
PendingOutOfBandOperations operation.
-
PendingOutOfBandOperationsNetworkError
-
A network error occurred.
-
PendingOutOfBandOperationsNoDeviceLockError
-
The device has no secure lock screen.
-
PendingOutOfBandOperationsOperationNotSupportedByBackend
-
The backend does not support the retrieval of out-of-band operations.
-
PendingOutOfBandOperationsResult
-
The object with the non-redeemed out-of-band operations returned by nevisFIDO
in the Get Device Out-of-Band Operations
service.
-
PendingOutOfBandOperationsUnknownError
-
Unknown operation error, handling not categorized error cases.
-
PendingOutOfBandPlatformOperation
-
Helps in following the states of pending out-of-band operations during method
channel calls.
-
PinAuthenticatorProtectionStatus
-
The object describing the PIN authenticator protection status.
-
PinChangeContext
-
The object providing some contextual information during PIN change.
-
PinChangeDeviceProtectionError
-
An error that indicates that some form of tampering was found in the application
during PIN change.
-
PinChangeError
-
The error returned when the PIN change failed.
-
PinChangeHandler
-
The object handling the old and new PIN provided by the end-user.
-
PinChangeNoDeviceLockError
-
The error that occurs when the device has no secure lock screen during a PIN
change.
-
PinChangePinLocked
-
The error that occurs when the PIN was locked because of too many failures.
-
PinChangePinNotEnrolled
-
The error that occurs when the specified user during a PIN change operation
does not have an enrolled PIN.
-
PinChanger
-
The object in charge of PIN change.
-
PinChangeRecoverableCustomValidationError
-
The provided PIN has failed the validation done in PinPolicy.validatePinForPinChange.
-
PinChangeRecoverableError
-
The recoverable error that can occur when changing a PIN.
-
PinChangeRecoverableInvalidPin
-
The provided old PIN is not valid.
-
PinChangeRecoverableInvalidPinFormat
-
The provided new PIN is not compliant with the PinPolicy.
-
PinChangeRecoverableOldPinEqualsNewPin
-
The old and new PINs are equal. The new PIN must be different from the old PIN.
-
PinChangeUnknownError
-
Unknown PIN change error, handling not categorized error cases.
-
PinChangeUserCanceled
-
The error that occurs when the PIN change was cancelled.
-
PinChangeUserNotResponsive
-
The error that occurs when the user took too long to provide the PIN during the change operation.
-
PinEnroller
-
The object in charge of PIN enrollment.
-
PinEnrollmentContext
-
The object providing some contextual information during PIN enrollment.
-
PinEnrollmentCustomValidationError
-
The provided PIN has failed the validation done in PinPolicy.validatePinForEnrollment.
-
PinEnrollmentError
-
The object that informs that an error occurred during PIN enrollment.
-
PinEnrollmentHandler
-
The object handling the PIN to be enrolled.
-
PinEnrollmentInvalidPinFormat
-
The provided PIN is not compliant with the PinPolicy.
-
PinMessage
-
Holds the parameters of the pin operation platform channel call.
-
PinPolicy
-
The object defining the minimum and maximum length of the PIN.
-
PinPolicyImpl
-
Default implementation for PinPolicy.
-
PinPolicyMessage
-
Holds the parameters of PIN policy.
-
PinPolicyProvider
-
An object defining the PinPolicy.
-
PinProtectionStatusLastAttemptFailed
-
An invalid PIN was provided previously.
-
PinProtectionStatusLockedOut
-
The authenticator is locked and cannot be used.
-
PinProtectionStatusUnlocked
-
The authenticator is unlocked and can be used.
-
PinsMessage
-
Holds the parameters of the PIN change operation platform channel call.
-
PinUserVerificationContext
-
The object providing information about the PIN user verification
(i.e. the user credential validation) operation to be done.
-
PinUserVerificationHandler
-
The objects consuming the outcome of an interaction where the user provides
PIN credentials.
-
PinUserVerifier
-
The object in charge of interacting with the user to do PIN authentication.
-
PinValidatedMessage
-
Holds the parameters of the pin validation platform channel call.
-
PlatformChannelError
-
A class representing the errors thrown during platform channel calls.
-
PlatformChannelIllegalArgumentError
-
An error that indicates that an illegal or inappropriate parameter has been
passed to a method.
-
PlatformChannelMappingError
-
An error that indicates that the mapping failed during a platform call.
-
PlatformChannelNoOperationFoundError
-
An error that indicates that no operation found with a given identifier.
-
PlatformChannelNullPointerError
-
An error that indicates that a parameter is
null in a case where it is required.
-
PlatformChannelOperationAlreadyExistsError
-
An error that indicates that an operation already exists with the given identifier.
-
PlatformChannelOperationNullError
-
An error that indicates that an operation with the given identifier does not
exist.
-
PlatformChannelUnknownError
-
An error that indicates that something failed during a platform call.
-
PlatformChannelWrongOperationTypeError
-
An error that indicates that an operation with the given identifier has wrong
type.
-
PlatformMetaData
-
The object containing information about the Nevis Mobile Authentication SDK.
-
PlatformOperation<T extends SuccessResponse>
-
Helps in following the states of started operations during method channel
calls.
-
PlatformOperationCache
-
An operation cache that helps saving and identifying multiple operations and
their state.
-
PlatformOperationCacheImpl
-
Default implementation of PlatformOperationCache.
-
PlatformResult<T>
-
Represents a correct response from the platform channel calls.
-
PromptOptions
-
Defines the elements of a user prompt.
-
RecoverableError
-
The interface implemented by all recoverable errors.
-
RedeemData
-
The data with the information required to redeem the token.
-
RegistrationInfo
-
The object exposing the registration information for an Authenticator.
-
RegistrationMessage
-
Holds the parameters of the registration operation platform channel call.
-
RegistrationPlatformOperation
-
Helps in following the states of registration operations during method channel
calls.
-
The interface defining the HTTP headers that can be provided to
HttpOperation.
The headers can be used for example to correlate multiple operations in the
backend: a header with an identifier can be provided to the HttpOperation,
and the header will be included in the HTTP request. If the identifier can be
associated with a more general operation (like a user enrollment), the backend
will be able to link the requests made by the SDK with that more generic operation.
-
RetryPolicy
-
Some of the operations of the SDK allow to retry the operation (or part of
the operation).
-
SdkMethodNames
-
The basic SDK method names.
-
SdkUserEnrollment
-
The object containing the user enrollment information for an authenticator
whose credentials are managed by the SDK (like the PIN and password authenticator).
-
Server
-
The object defining a server. Each Account is defined in a given Server object.
-
SessionProvider
-
Provides the elements required to run an operation in a session.
-
StrictMode
-
The device supports the
default and strict full basic attestation modes
as described in the nevisFIDO documentation.
-
StrictStrongBoxMode
-
The device supports the
default, strict and strict-strongbox full basic
attestation modes as described in the nevisFIDO documentation.
-
SuccessResponse
-
Base class of all parameter type for a success callback from native side.
-
UserEnrollment
-
The object containing the user enrollment information.
-
UserInteractionMethodNames
-
The user interaction method names.
-
UserInteractionPlatformOperation
-
Helps in following the states of user interaction operations during method
channel calls.
-
UserInteractionsPlatformInterface
-
Holds user interaction related platform calls.
-
UserVerificationContext
-
The object describing the user verification (i.e. the user credential validation)
operation to be done.
-
UserVerificationHandler
-
The objects consuming the outcome of an interaction where the user provides
credentials.
-
VerifyPasswordMessage
-
Holds the parameters of the verify password operation platform channel call.
-
VerifyPinMessage
-
Holds the parameters of the verify PIN operation platform channel call.
-
Version
-
Represents a generic version with
major, minor, patch and buildNumber
fields.
Enums
-
Aaid
-
The authenticator attestation identifier: a unique identifier assigned to a
model, class or batch of FIDO Authenticators that all share the same characteristics,
and which a Relying Party can use to look up an Attestation Public Key and
Authenticator Metadata for the device.
-
CertificateChainValidationResult
-
The result of the certificate validation done to know if the keys generated
by the device have been generated using a chipset containing a
Google root certificate.
-
ContentType
-
The content type of the OutOfBandPayload.
-
DispatchChannel
-
The different dispatch channels (dispatchers in nevisFIDO terminology) that
can be used with to transmit the out-of-band operation: the out-of-band operation
reaches the application either through a QR code, an FCM push notification or a link.
-
FidoErrorCodeType
-
Collection error codes based on the FIDO UAF client error codes.
-
OutOfBandPlatformOperationType
-
Represents the eligible types of an out-of-band operation.
-
SecurityLevel
-
Indicates the level of protection of the FIDO UAF keys in the device as defined
here.
-
UserInteractionState
-
Represents the eligible states of an operation that required user interaction.