Index
All Classes and Interfaces|All Packages|Constant Field Values
A
- aaid() - Method in interface ch.nevis.mobile.sdk.api.localdata.Authenticator
-
The "Authenticator Attestation ID" (AAID), which identifies the type and batch of the authenticator.
- aaid() - Method in interface ch.nevis.mobile.sdk.api.operation.DeviceInformationMismatch.MissingAuthenticatorInMobileDevice
-
The AAID of the missing authenticator.
- aaid() - Method in interface ch.nevis.mobile.sdk.api.operation.DeviceInformationMismatch.MissingAuthenticatorInServer
-
The AAID of the missing authenticator.
- aaid(String) - Method in interface ch.nevis.mobile.sdk.api.operation.Deregistration
-
Specifies the AAID of the
Authenticator
that must be deregistered. - aaid(String) - Method in interface ch.nevis.mobile.sdk.api.operation.selection.AuthenticatorSelectionHandler
-
Provides the AAID of the authenticator selected by the user.
- accept(T) - Method in interface ch.nevis.mobile.sdk.api.util.Consumer
-
Performs this operation on the given argument.
- account() - Method in interface ch.nevis.mobile.sdk.api.operation.DeviceInformationMismatch.MissingAuthenticatorInServer
-
The account associated with the missing authenticator.
- account() - Method in interface ch.nevis.mobile.sdk.api.operation.selection.AuthenticatorSelectionContext
-
The account used to execute the operation.
- Account - Interface in ch.nevis.mobile.sdk.api.localdata
-
The object representing a user account.
- accounts() - Method in interface ch.nevis.mobile.sdk.api.localdata.LocalData
-
Convenience method that returns all the registered accounts.
- accounts() - Method in interface ch.nevis.mobile.sdk.api.operation.selection.AccountSelectionContext
-
The accounts that have been registered with the SDK.
- AccountSelectionContext - Interface in ch.nevis.mobile.sdk.api.operation.selection
-
The service returning the information required to choose the account to be used: it returns all the available accounts and authenticators and also informs whether a given authenticator is compliant with the policy required by the FIDO UAF server for the ongoing operation.
- AccountSelectionHandler - Interface in ch.nevis.mobile.sdk.api.operation.selection
-
The object handling the outcome of an interaction where the user chooses the account to be used.
- accountSelector(AccountSelector) - Method in interface ch.nevis.mobile.sdk.api.operation.outofband.OutOfBandAuthentication
-
Specifies the
AccountSelector
to be used during the out-of-band authentication. - AccountSelector - Interface in ch.nevis.mobile.sdk.api.operation.selection
-
The object in charge of selecting an account.
- additionalInformation() - Method in interface ch.nevis.mobile.sdk.api.operation.outofband.PendingOutOfBandOperation
-
Additional information that is not included in the
OutOfBandPayload
. - allowClass2Sensors(boolean) - Method in interface ch.nevis.mobile.sdk.api.operation.authcloudapi.AuthCloudApiRegistration
-
Specifies whether Class 2 (formerly weak) biometric sensors are allowed if the biometric authenticator is selected.
- allowClass2Sensors(boolean) - Method in interface ch.nevis.mobile.sdk.api.operation.outofband.OutOfBandRegistration
-
Specifies whether Class 2 (formerly weak) biometric sensors are allowed if the biometric authenticator is selected.
- allowClass2Sensors(boolean) - Method in interface ch.nevis.mobile.sdk.api.operation.Registration
-
Specifies whether Class 2 (formerly weak) biometric sensors are allowed if the biometric authenticator is selected.
- allowDevicePasscodeAsFallback(boolean) - Method in interface ch.nevis.mobile.sdk.api.operation.authcloudapi.AuthCloudApiRegistration
-
Specifies whether the OS device passcode (PIN, password, gesture) can be used as fallback during biometric authentication.
- allowDevicePasscodeAsFallback(boolean) - Method in interface ch.nevis.mobile.sdk.api.operation.outofband.OutOfBandRegistration
-
Specifies whether the OS device passcode (PIN, password, gesture) can be used as fallback during biometric authentication.
- allowDevicePasscodeAsFallback(boolean) - Method in interface ch.nevis.mobile.sdk.api.operation.Registration
-
Specifies whether the OS device passcode (PIN, password, gesture) can be used as fallback during biometric authentication.
- AndroidOnly - Annotation Interface in ch.nevis.mobile.sdk.api.util
-
Classes and methods marked with this annotation are Android specific.
- application(Application) - Method in interface ch.nevis.mobile.sdk.api.MobileAuthenticationClientInitializer
-
Deprecated.
- appLinkUri(String) - Method in interface ch.nevis.mobile.sdk.api.operation.authcloudapi.AuthCloudApiRegistration
-
Specifies the value of the
appLinkUri
attribute in the enroll response sent by the server. - AuthCloudApiError - Interface in ch.nevis.mobile.sdk.api.operation.authcloudapi
-
The error that can occur when the registration using the the Authentication Cloud API fails.
- AuthCloudApiError.DecryptionError - Interface in ch.nevis.mobile.sdk.api.operation.authcloudapi
-
The encrypted contents of the Authentication Cloud API response could not be decrypted.
- AuthCloudApiError.DeviceProtectionError - Interface in ch.nevis.mobile.sdk.api.operation.authcloudapi
-
An error that indicates that some form of tampering was found in the application.
- AuthCloudApiError.MalformedResponse - Interface in ch.nevis.mobile.sdk.api.operation.authcloudapi
-
A problem with the provided Authentication Cloud API response occurred.
- AuthCloudApiError.NetworkError - Interface in ch.nevis.mobile.sdk.api.operation.authcloudapi
-
A network error occurred while redeeming the token: either the server was not reachable or it returned an HTTP error.
- AuthCloudApiError.NoDeviceLockError - Interface in ch.nevis.mobile.sdk.api.operation.authcloudapi
-
The android device has no secure lock screen.
- AuthCloudApiError.OperationError - Interface in ch.nevis.mobile.sdk.api.operation.authcloudapi
-
An error occurred at the FIDO UAF protocol level.
- AuthCloudApiError.OperationError.ClockSkewTooBig - Interface in ch.nevis.mobile.sdk.api.operation.authcloudapi
-
The clocks on the mobile and on the server are too apart and the server refused to validate the JWS.
- AuthCloudApiError.TokenAlreadyRedeemed - Interface in ch.nevis.mobile.sdk.api.operation.authcloudapi
-
The token was already redeemed.
- AuthCloudApiError.TokenExpired - Interface in ch.nevis.mobile.sdk.api.operation.authcloudapi
-
The token has expired.
- authCloudApiRegistration() - Method in interface ch.nevis.mobile.sdk.api.operation.Operations
-
Returns a
AuthCloudApiRegistration
object. - AuthCloudApiRegistration - Interface in ch.nevis.mobile.sdk.api.operation.authcloudapi
-
The object that can be used to trigger a registration operation from the response to the Authentication Cloud API enroll request.
- authCloudBuilder() - Static method in interface ch.nevis.mobile.sdk.api.Configuration
-
Returns a new
Configuration.AuthCloudBuilder
. - authentication() - Method in interface ch.nevis.mobile.sdk.api.operation.Operations
-
Returns a
Authentication
object. - Authentication - Interface in ch.nevis.mobile.sdk.api.operation
-
The object that can be used to trigger an authentication operation.
- AuthenticationError - Interface in ch.nevis.mobile.sdk.api.operation
-
An extension of
OperationError
for theAuthentication
) operation. - authenticationMaxRetries() - Method in interface ch.nevis.mobile.sdk.api.Configuration
-
Deprecated.use
Authentication.retryPolicyObtainingAuthorizationProvider(RetryPolicy)
instead. The value returned by this method will be ignored. - authenticationMaxRetries(int) - Method in interface ch.nevis.mobile.sdk.api.Configuration.AuthCloudBuilder
-
Sets the maximum number of retries for authentication.
- authenticationMaxRetries(int) - Method in interface ch.nevis.mobile.sdk.api.Configuration.Builder
-
Sets the maximum number of retries for authentication.
- authenticationRequestPath() - Method in interface ch.nevis.mobile.sdk.api.Configuration
-
The authentication request URL path used to send the FIDO UAF authentication GetUafRequest.
- authenticationRequestPath(String) - Method in interface ch.nevis.mobile.sdk.api.Configuration.Builder
-
Sets the authentication request path URL.
- authenticationResponsePath() - Method in interface ch.nevis.mobile.sdk.api.Configuration
-
The authentication response URL path used to send the final FIDO UAF authentication response.
- authenticationResponsePath(String) - Method in interface ch.nevis.mobile.sdk.api.Configuration.Builder
-
Sets the authentication response path URL.
- authenticationRetryIntervalInSeconds() - Method in interface ch.nevis.mobile.sdk.api.Configuration
-
Deprecated.use
Authentication.retryPolicyObtainingAuthorizationProvider(RetryPolicy)
instead. The value returned by this method will be ignored. - authenticationRetryIntervalInSeconds(long) - Method in interface ch.nevis.mobile.sdk.api.Configuration.AuthCloudBuilder
-
Sets the time interval for authentication in seconds.
- authenticationRetryIntervalInSeconds(long) - Method in interface ch.nevis.mobile.sdk.api.Configuration.Builder
-
Sets the time interval for authentication in seconds.
- authenticator() - Method in interface ch.nevis.mobile.sdk.api.operation.userverification.UserVerificationContext
-
The authenticator to be used to do the user verification.
- Authenticator - Interface in ch.nevis.mobile.sdk.api.localdata
-
An object describing an authenticator.
- AUTHENTICATOR_ACCESS_DENIED - Enum constant in enum class ch.nevis.mobile.sdk.api.operation.FidoErrorCode
-
The authenticator denied access to the resulting request.
- authenticatorProtectionStatus() - Method in interface ch.nevis.mobile.sdk.api.operation.password.PasswordChangeContext
-
The object describing the password protection status (whether is locked, in cool-down mode, etc.).
- authenticatorProtectionStatus() - Method in interface ch.nevis.mobile.sdk.api.operation.pin.PinChangeContext
-
The object describing the PIN protection status (whether is locked, in cool-down mode, etc.).
- authenticatorProtectionStatus() - Method in interface ch.nevis.mobile.sdk.api.operation.userverification.PasswordUserVerificationContext
-
The authenticator protection status.
- authenticatorProtectionStatus() - Method in interface ch.nevis.mobile.sdk.api.operation.userverification.PinUserVerificationContext
-
The authenticator protection status.
- authenticators() - Method in interface ch.nevis.mobile.sdk.api.localdata.LocalData
-
Returns information about the authenticators.
- authenticators() - Method in interface ch.nevis.mobile.sdk.api.operation.selection.AccountSelectionContext
-
The available authenticators.
- authenticators() - Method in interface ch.nevis.mobile.sdk.api.operation.selection.AuthenticatorSelectionContext
-
The available authenticators.
- AuthenticatorSelectionContext - Interface in ch.nevis.mobile.sdk.api.operation.selection
-
The service returning the information required to choose the authenticator to be used: it returns all the available authenticators, the operation being executed and also informs whether a given authenticator is compliant with the policy required by the FIDO UAF server for the ongoing operation.
- AuthenticatorSelectionHandler - Interface in ch.nevis.mobile.sdk.api.operation.selection
-
The object handling the outcome of an interaction where the user chooses the authenticator to be used.
- authenticatorSelector(AuthenticatorSelector) - Method in interface ch.nevis.mobile.sdk.api.operation.authcloudapi.AuthCloudApiRegistration
-
Specifies the object that will take care of the selection of the authenticator to be used.
- authenticatorSelector(AuthenticatorSelector) - Method in interface ch.nevis.mobile.sdk.api.operation.Authentication
-
Specifies the object that will take care of the selection of the authenticator to be used.
- authenticatorSelector(AuthenticatorSelector) - Method in interface ch.nevis.mobile.sdk.api.operation.outofband.OutOfBandAuthentication
-
Specifies the object that will take care of the selection of the authenticator to be used.
- authenticatorSelector(AuthenticatorSelector) - Method in interface ch.nevis.mobile.sdk.api.operation.outofband.OutOfBandRegistration
-
Specifies the object that will take care of the selection of the authenticator to be used.
- authenticatorSelector(AuthenticatorSelector) - Method in interface ch.nevis.mobile.sdk.api.operation.Registration
-
Specifies the object that will take care of the selection of the authenticator to be used.
- AuthenticatorSelector - Interface in ch.nevis.mobile.sdk.api.operation.selection
-
The object in charge of selecting the authenticator to be used to perform an operation.
- authorizationProvider(AuthorizationProvider) - Method in interface ch.nevis.mobile.sdk.api.operation.Deregistration
-
Specifies the authorization provider that must be used to deregister the authenticator.
- authorizationProvider(AuthorizationProvider) - Method in interface ch.nevis.mobile.sdk.api.operation.Registration
-
Specifies the authorization provider that must be used to register.
- AuthorizationProvider - Interface in ch.nevis.mobile.sdk.api.authorization
-
Provides the authorization elements required to perform protected operations.
- AuthorizationProvider.CookieAuthorizationProvider - Interface in ch.nevis.mobile.sdk.api.authorization
-
An HTTP cookie based authorization provider.
- AuthorizationProvider.EmptyAuthorizationProvider - Interface in ch.nevis.mobile.sdk.api.authorization
-
An
AuthorizationProvider
providing no authorization. - AuthorizationProvider.JwsAuthorizationProvider - Interface in ch.nevis.mobile.sdk.api.authorization
-
An authorization provider using JWS to do the authorization.
- AuthorizationProvider.JwtAuthorizationProvider - Interface in ch.nevis.mobile.sdk.api.authorization
-
An JWT based authorization provider.
B
- base64UrlEncoded(String) - Method in interface ch.nevis.mobile.sdk.api.operation.outofband.OutOfBandPayloadDecode
-
Specifies the JSON as base 64 URL to be decoded
- baseUrl() - Method in interface ch.nevis.mobile.sdk.api.Configuration
-
The default base URL for the HTTP endpoints the SDK must interact with.
- baseUrl() - Method in interface ch.nevis.mobile.sdk.api.localdata.Server
-
The base URL for the server.
- baseUrl(URI) - Method in interface ch.nevis.mobile.sdk.api.Configuration.Builder
-
Sets the base URL.
- BIOMETRIC_AUTHENTICATOR_AAID - Static variable in interface ch.nevis.mobile.sdk.api.localdata.Authenticator
-
The AAID of the Biometric authenticator.
- BiometricPromptOptions - Interface in ch.nevis.mobile.sdk.api.operation.userverification
-
Defines the elements of the biometric prompt (title and description).
- BiometricPromptOptions.Builder - Interface in ch.nevis.mobile.sdk.api.operation.userverification
-
A builder for
BiometricPromptOptions
. - BiometricUserVerificationContext - Interface in ch.nevis.mobile.sdk.api.operation.userverification
-
The object providing information about the biometric user verification (i.e.
- BiometricUserVerificationHandler - Interface in ch.nevis.mobile.sdk.api.operation.userverification
-
The object handling the outcome of an interaction where the user provides biometric credentials.
- biometricUserVerifier(BiometricUserVerifier) - Method in interface ch.nevis.mobile.sdk.api.operation.authcloudapi.AuthCloudApiRegistration
-
Specifies the object that will take care of the biometric user verification.
- biometricUserVerifier(BiometricUserVerifier) - Method in interface ch.nevis.mobile.sdk.api.operation.Authentication
-
Specifies the object that will take care of the biometric user verification.
- biometricUserVerifier(BiometricUserVerifier) - Method in interface ch.nevis.mobile.sdk.api.operation.outofband.OutOfBandAuthentication
-
Specifies the object that will take care of the biometric user verification.
- biometricUserVerifier(BiometricUserVerifier) - Method in interface ch.nevis.mobile.sdk.api.operation.outofband.OutOfBandRegistration
-
Specifies the object that will take care of the biometric user verification.
- biometricUserVerifier(BiometricUserVerifier) - Method in interface ch.nevis.mobile.sdk.api.operation.Registration
-
Specifies the object that will take care of the biometric user verification.
- BiometricUserVerifier - Interface in ch.nevis.mobile.sdk.api.operation.userverification
-
The object in charge of interacting with the user to do biometric authentication.
- build() - Method in interface ch.nevis.mobile.sdk.api.Configuration.AuthCloudBuilder
-
Creates a
Configuration
. - build() - Method in interface ch.nevis.mobile.sdk.api.Configuration.Builder
-
Creates a
Configuration
. - build() - Method in interface ch.nevis.mobile.sdk.api.localdata.DeviceInformation.Builder
-
Creates a
DeviceInformation
. - build() - Method in interface ch.nevis.mobile.sdk.api.operation.password.PasswordChangeRecoverableError.CustomValidationError.Builder
- build() - Method in interface ch.nevis.mobile.sdk.api.operation.password.PasswordEnrollmentError.Builder
-
Builds a
PasswordEnrollmentError
. - build() - Method in interface ch.nevis.mobile.sdk.api.operation.pin.PinChangeRecoverableError.CustomValidationError.Builder
- build() - Method in interface ch.nevis.mobile.sdk.api.operation.pin.PinEnrollmentError.CustomValidationError.Builder
-
Builds a
PinEnrollmentError.CustomValidationError
. - build() - Method in interface ch.nevis.mobile.sdk.api.operation.pin.PinPolicy.Builder
-
Builds a
PinPolicy
. - build() - Method in interface ch.nevis.mobile.sdk.api.operation.RetryPolicy.Constant.Builder
-
Builds a
Constant
object - build() - Method in interface ch.nevis.mobile.sdk.api.operation.RetryPolicy.Exponential.Builder
-
Builds a
Exponential
object - build() - Method in interface ch.nevis.mobile.sdk.api.operation.userverification.BiometricPromptOptions.Builder
-
Creates a
BiometricPromptOptions
. - build() - Method in interface ch.nevis.mobile.sdk.api.operation.userverification.DevicePasscodePromptOptions.Builder
-
Creates a
DevicePasscodePromptOptions
. - builder() - Static method in interface ch.nevis.mobile.sdk.api.Configuration
-
Returns a new
Configuration.Builder
. - builder() - Static method in interface ch.nevis.mobile.sdk.api.localdata.DeviceInformation
-
Returns a new
DeviceInformation.Builder
. - builder() - Static method in interface ch.nevis.mobile.sdk.api.operation.password.PasswordChangeRecoverableError.CustomValidationError
-
Returns a new
Builder
. - builder() - Static method in interface ch.nevis.mobile.sdk.api.operation.password.PasswordEnrollmentError
-
Returns a new
PasswordEnrollmentError.Builder
. - builder() - Static method in interface ch.nevis.mobile.sdk.api.operation.pin.PinChangeRecoverableError.CustomValidationError
-
Returns a new
CustomValidationError.Builder
. - builder() - Static method in interface ch.nevis.mobile.sdk.api.operation.pin.PinEnrollmentError.CustomValidationError
-
Returns a new
CustomValidationError.Builder
. - builder() - Static method in interface ch.nevis.mobile.sdk.api.operation.pin.PinPolicy
-
Returns an object that can be used to build a
PinPolicy
. - builder() - Static method in interface ch.nevis.mobile.sdk.api.operation.RetryPolicy.Constant
-
Returns an object that can be used to build a
RetryPolicy
. - builder() - Static method in interface ch.nevis.mobile.sdk.api.operation.RetryPolicy.Exponential
-
Returns an object that can be used to build a
RetryPolicy
. - builder() - Static method in interface ch.nevis.mobile.sdk.api.operation.userverification.BiometricPromptOptions
-
Returns a new
BiometricPromptOptions.Builder
. - builder() - Static method in interface ch.nevis.mobile.sdk.api.operation.userverification.DevicePasscodePromptOptions
-
Returns a new
DevicePasscodePromptOptions.Builder
. - buildNumber() - Method in interface ch.nevis.mobile.sdk.api.metadata.Version
-
Gives back the
buildNumber
field of the version, such as 4 in version 1.5.3.4.
C
- cancel() - Method in interface ch.nevis.mobile.sdk.api.operation.CancelableHandler
-
This method must be invoked if the operation must be canceled.
- cancel() - Method in interface ch.nevis.mobile.sdk.api.operation.password.PasswordChangeHandler
-
This method must be invoked if the operation must be canceled.
- cancel() - Method in interface ch.nevis.mobile.sdk.api.operation.password.PasswordEnrollmentHandler
-
This method must be invoked if the operation must be canceled.
- cancel() - Method in interface ch.nevis.mobile.sdk.api.operation.pin.PinChangeHandler
-
This method must be invoked if the operation must be canceled.
- cancel() - Method in interface ch.nevis.mobile.sdk.api.operation.pin.PinEnrollmentHandler
-
This method must be invoked if the operation must be canceled.
- cancel() - Method in interface ch.nevis.mobile.sdk.api.operation.selection.AccountSelectionHandler
-
This method must be invoked if the operation must be canceled.
- cancel() - Method in interface ch.nevis.mobile.sdk.api.operation.selection.AuthenticatorSelectionHandler
-
This method must be invoked if the operation must be canceled.
- cancel() - Method in interface ch.nevis.mobile.sdk.api.operation.userverification.BiometricUserVerificationHandler
-
The user verification was canceled.
- cancel() - Method in interface ch.nevis.mobile.sdk.api.operation.userverification.DevicePasscodeUserVerificationHandler
-
The user verification was canceled.
- cancel() - Method in interface ch.nevis.mobile.sdk.api.operation.userverification.FingerprintUserVerificationHandler
-
The user verification was canceled.
- cancel() - Method in interface ch.nevis.mobile.sdk.api.operation.userverification.PasswordUserVerificationHandler
-
The method to be invoked to cancel the user verification.
- cancel() - Method in interface ch.nevis.mobile.sdk.api.operation.userverification.PinUserVerificationHandler
-
The user verification was canceled.
- CancelableHandler - Interface in ch.nevis.mobile.sdk.api.operation
-
The interface that operation handlers inherit from.
- cancelAuthentication() - Method in interface ch.nevis.mobile.sdk.api.operation.userverification.OsAuthenticationListenHandler
-
Cancels the authentication operation.
- cancelButtonText() - Method in interface ch.nevis.mobile.sdk.api.operation.userverification.BiometricPromptOptions
-
Returns the cancel button text.
- cancelButtonText(String) - Method in interface ch.nevis.mobile.sdk.api.operation.userverification.BiometricPromptOptions.Builder
-
Sets the cancel button text.
- cause() - Method in interface ch.nevis.mobile.sdk.api.MobileAuthenticationClientError
-
The exception (if any) that caused this error.
- cause(Exception) - Method in interface ch.nevis.mobile.sdk.api.operation.password.PasswordChangeRecoverableError.CustomValidationError.Builder
-
Sets the
Exception
that caused the error. - cause(Exception) - Method in interface ch.nevis.mobile.sdk.api.operation.password.PasswordEnrollmentError.Builder
-
Sets the
Exception
that caused the error. - cause(Exception) - Method in interface ch.nevis.mobile.sdk.api.operation.pin.PinChangeRecoverableError.CustomValidationError.Builder
-
Sets the
Exception
that caused the error. - cause(Exception) - Method in interface ch.nevis.mobile.sdk.api.operation.pin.PinEnrollmentError.CustomValidationError.Builder
-
Sets the
Exception
that caused the error. - ch.nevis.mobile.sdk.api - package ch.nevis.mobile.sdk.api
-
Contains the
MobileAuthenticationClient
interface, which is the entry point to the SDK. - ch.nevis.mobile.sdk.api.authorization - package ch.nevis.mobile.sdk.api.authorization
-
Interfaces providing authorization that grants access to protected services.
- ch.nevis.mobile.sdk.api.localdata - package ch.nevis.mobile.sdk.api.localdata
-
Interfaces providing information about the data stored by the SDK: the authenticators and the enrollment and registration information and the device information.
- ch.nevis.mobile.sdk.api.metadata - package ch.nevis.mobile.sdk.api.metadata
- ch.nevis.mobile.sdk.api.operation - package ch.nevis.mobile.sdk.api.operation
-
The package that allows to do the different operations: such as registering an authenticator, using an authenticator to authenticate or deregistering an authenticator.
- ch.nevis.mobile.sdk.api.operation.authcloudapi - package ch.nevis.mobile.sdk.api.operation.authcloudapi
-
The package containing the interfaces that allow to do registration using the Authentication Cloud API.
- ch.nevis.mobile.sdk.api.operation.outofband - package ch.nevis.mobile.sdk.api.operation.outofband
-
The package containing the interfaces that allow to do out-of-band registration, out-of-band authentication operations and the modification of the device information.
- ch.nevis.mobile.sdk.api.operation.password - package ch.nevis.mobile.sdk.api.operation.password
-
The package containing the interfaces that allow to do password related operations: password enrollment and password change.
- ch.nevis.mobile.sdk.api.operation.pin - package ch.nevis.mobile.sdk.api.operation.pin
-
The package containing the interfaces that allow to do PIN related operations: PIN enrollment and PIN change.
- ch.nevis.mobile.sdk.api.operation.selection - package ch.nevis.mobile.sdk.api.operation.selection
-
The interfaces that allow to specify the authenticator to be used during registration and authentication (both in-band and out-of-band).
- ch.nevis.mobile.sdk.api.operation.userverification - package ch.nevis.mobile.sdk.api.operation.userverification
-
The interfaces dealing with user verification (PIN, fingerprint or biometric).
- ch.nevis.mobile.sdk.api.util - package ch.nevis.mobile.sdk.api.util
-
Generic utility interfaces.
- changePassword(PasswordChangeContext, PasswordChangeHandler) - Method in interface ch.nevis.mobile.sdk.api.operation.password.PasswordChanger
-
The method that will be invoked till either the user provides the old password and a new password that conforms to the format expected by the SDK (i.e.
- changePin(PinChangeContext, PinChangeHandler) - Method in interface ch.nevis.mobile.sdk.api.operation.pin.PinChanger
-
The method that will be invoked till either the user provides the old PIN and a new PIN that conforms to the format expected by the SDK (i.e.
- code() - Method in enum class ch.nevis.mobile.sdk.api.operation.FidoErrorCode
-
Returns the code associated with this error.
- configuration(Configuration) - Method in interface ch.nevis.mobile.sdk.api.MobileAuthenticationClientInitializer
-
Sets the configuration of the
MobileAuthenticationClient
. - Configuration - Interface in ch.nevis.mobile.sdk.api
-
The
MobileAuthenticationClient
configuration. - Configuration.AuthCloudBuilder - Interface in ch.nevis.mobile.sdk.api
-
A simplified builder that can be used to configure an SDK when your application works with the Nevis Authentication Cloud.
- Configuration.Builder - Interface in ch.nevis.mobile.sdk.api
-
A builder for
Configuration
. - Consumer<T> - Interface in ch.nevis.mobile.sdk.api.util
-
Represents an operation that accepts a single input argument and returns no result.
- contentType() - Method in interface ch.nevis.mobile.sdk.api.operation.outofband.OutOfBandPayload
-
The content type of the NMA (Nevis Mobile Authentication) data.
- ContentType - Enum Class in ch.nevis.mobile.sdk.api.operation.outofband
-
The content type of the
OutOfBandPayload
. - context(Context) - Method in interface ch.nevis.mobile.sdk.api.MobileAuthenticationClientInitializer
-
Sets the Android context.
- Cookie - Interface in ch.nevis.mobile.sdk.api.authorization
-
An object encapsulating an HTTP cookie.
- cookies() - Method in interface ch.nevis.mobile.sdk.api.authorization.AuthorizationProvider.CookieAuthorizationProvider
-
The cookies that can be used to do authorization.
- cookies() - Method in interface ch.nevis.mobile.sdk.api.authorization.SessionProvider.CookieSessionProvider
-
The session cookies.
- coolDownTimeInSeconds() - Method in interface ch.nevis.mobile.sdk.api.operation.password.PasswordAuthenticatorProtectionStatus.LastAttemptFailed
-
The time that must be passed before the user can try to provide credentials again.
- coolDownTimeInSeconds() - Method in interface ch.nevis.mobile.sdk.api.operation.pin.PinAuthenticatorProtectionStatus.LastAttemptFailed
-
The time that must be passed before the user can try to provide credentials again.
- create(String) - Static method in interface ch.nevis.mobile.sdk.api.authorization.Jwt
-
Creates a JWT from the provide JWT representation.
- create(String...) - Static method in interface ch.nevis.mobile.sdk.api.operation.RequestHeaders
-
Creates a
RequestHeaders
fromString
varargs. - create(URI, String) - Static method in interface ch.nevis.mobile.sdk.api.authorization.Cookie
-
Creates a cookie.
- create(List<Cookie>) - Static method in interface ch.nevis.mobile.sdk.api.authorization.AuthorizationProvider.CookieAuthorizationProvider
-
Returns a new
CookieAuthorizationProvider
. - create(List<Cookie>) - Static method in interface ch.nevis.mobile.sdk.api.authorization.SessionProvider.CookieSessionProvider
-
Returns a new
CookieSessionProvider
. - create(Map<String, String>) - Static method in interface ch.nevis.mobile.sdk.api.operation.RequestHeaders
-
Creates a
RequestHeaders
objects from aMap
. - createBearer(Jwt) - Static method in interface ch.nevis.mobile.sdk.api.authorization.AuthorizationProvider.JwtAuthorizationProvider
- createBearer(Jwt) - Static method in interface ch.nevis.mobile.sdk.api.authorization.SessionProvider.JwtSessionProvider
- createFromMultimap(Map<String, List<String>>) - Static method in interface ch.nevis.mobile.sdk.api.operation.RequestHeaders
-
Creates a
RequestHeaders
objects from a multimap. - creationTimeInEpochMillis() - Method in interface ch.nevis.mobile.sdk.api.operation.outofband.PendingOutOfBandOperation
-
The time the out-of-band operation was created (i.e.
D
- data() - Method in interface ch.nevis.mobile.sdk.api.operation.outofband.OutOfBandPayload
-
The optional additional information that it was provided when triggering the out-of-band operation.
- delayInSeconds() - Method in interface ch.nevis.mobile.sdk.api.operation.RetryPolicy.Constant
-
The period of time between retries.
- delayInSeconds(long) - Method in interface ch.nevis.mobile.sdk.api.operation.RetryPolicy.Constant.Builder
-
Sets the period of time between retries.
- deleteAuthenticator(String) - Method in interface ch.nevis.mobile.sdk.api.localdata.LocalData
-
Deletes all the data managed by the SDK regarding the provided user.
- deleteAuthenticator(String, String) - Method in interface ch.nevis.mobile.sdk.api.localdata.LocalData
-
Deletes all the data managed by the SDK regarding the provided authenticator.
- deregistration() - Method in interface ch.nevis.mobile.sdk.api.operation.Operations
-
Returns a
Deregistration
object. - Deregistration - Interface in ch.nevis.mobile.sdk.api.operation
-
The object that can be used to trigger a deregistration operation.
- deregistrationRequestPath() - Method in interface ch.nevis.mobile.sdk.api.Configuration
-
Returns the URL path used to obtain the FIDO UAF deregistration request.
- deregistrationRequestPath(String) - Method in interface ch.nevis.mobile.sdk.api.Configuration.Builder
-
Sets the deregistration path URL.
- description() - Method in interface ch.nevis.mobile.sdk.api.MobileAuthenticationClientError
-
Provides details about the error that occurred.
- description() - Method in enum class ch.nevis.mobile.sdk.api.operation.FidoErrorCode
-
Returns a description of the error.
- description() - Method in interface ch.nevis.mobile.sdk.api.operation.userverification.BiometricPromptOptions
-
The optional description to be used to prompt the user.
- description() - Method in interface ch.nevis.mobile.sdk.api.operation.userverification.DevicePasscodePromptOptions
-
The optional description to be used to prompt the user.
- description(String) - Method in interface ch.nevis.mobile.sdk.api.operation.password.PasswordChangeRecoverableError.CustomValidationError.Builder
-
Sets the description of the error.
- description(String) - Method in interface ch.nevis.mobile.sdk.api.operation.password.PasswordEnrollmentError.Builder
-
Sets the description of the error.
- description(String) - Method in interface ch.nevis.mobile.sdk.api.operation.pin.PinChangeRecoverableError.CustomValidationError.Builder
-
Sets the description of the error.
- description(String) - Method in interface ch.nevis.mobile.sdk.api.operation.pin.PinEnrollmentError.CustomValidationError.Builder
-
Sets the description of the error.
- description(String) - Method in interface ch.nevis.mobile.sdk.api.operation.userverification.BiometricPromptOptions.Builder
-
Sets the prompt description.
- description(String) - Method in interface ch.nevis.mobile.sdk.api.operation.userverification.DevicePasscodePromptOptions.Builder
-
Sets the prompt description.
- DEVICE_PASSCODE_AUTHENTICATOR_AAID - Static variable in interface ch.nevis.mobile.sdk.api.localdata.Authenticator
-
The AAID of the Device Passcode (PIN, password or gesture) authenticator.
- deviceId() - Method in interface ch.nevis.mobile.sdk.api.localdata.DeviceInformation
-
The identifier that is generated for the device during registration.
- deviceInformation() - Method in interface ch.nevis.mobile.sdk.api.localdata.LocalData
-
Returns information about the configured
DeviceInformation
(if any). - deviceInformation(DeviceInformation) - Method in interface ch.nevis.mobile.sdk.api.operation.authcloudapi.AuthCloudApiRegistration
-
Specifies the device information to be used.
- deviceInformation(DeviceInformation) - Method in interface ch.nevis.mobile.sdk.api.operation.outofband.OutOfBandRegistration
-
Specifies the device information to be used.
- deviceInformation(DeviceInformation) - Method in interface ch.nevis.mobile.sdk.api.operation.Registration
-
Specifies the device information to be used.
- DeviceInformation - Interface in ch.nevis.mobile.sdk.api.localdata
-
The object containing information of the device where the SDK is running.
- DeviceInformation.Builder - Interface in ch.nevis.mobile.sdk.api.localdata
-
A builder for
DeviceInformation
. - DeviceInformation.IdUsernamePair - Interface in ch.nevis.mobile.sdk.api.localdata
-
The
DeviceInformation
is stored a set of generic credentials representing dispatch targets in nevisIDM. - deviceInformationChange() - Method in interface ch.nevis.mobile.sdk.api.operation.Operations
-
Returns a
DeviceInformationChange
object. - DeviceInformationChange - Interface in ch.nevis.mobile.sdk.api.operation
-
The object that updates a device information.
- DeviceInformationChangeError - Interface in ch.nevis.mobile.sdk.api.operation.outofband
-
The error that can occur with operations related to a
DeviceInformation
. - DeviceInformationChangeError.ClockSkewTooBig - Interface in ch.nevis.mobile.sdk.api.operation.outofband
-
The clocks on the mobile and on the server are too apart and the server refused to validate the JWS sent to modify the device information.
- DeviceInformationChangeError.DeviceProtectionError - Interface in ch.nevis.mobile.sdk.api.operation.outofband
-
An error that indicates that some form of tampering was found in the application.
- DeviceInformationChangeError.NameAlreadyExists - Interface in ch.nevis.mobile.sdk.api.operation.outofband
-
There is already a device information with the provided name.
- DeviceInformationChangeError.NetworkError - Interface in ch.nevis.mobile.sdk.api.operation.outofband
-
A network error occurred.
- DeviceInformationChangeError.NoDeviceLockError - Interface in ch.nevis.mobile.sdk.api.operation.outofband
-
The android device has no secure lock screen.
- DeviceInformationChangeError.NotFound - Interface in ch.nevis.mobile.sdk.api.operation.outofband
-
The device information to be updated could not be found.
- deviceInformationCheck() - Method in interface ch.nevis.mobile.sdk.api.operation.Operations
-
Returns a
DeviceInformationCheck
object. - DeviceInformationCheck - Interface in ch.nevis.mobile.sdk.api.operation
-
The operation retrieving the mismatches that exist between the configuration in the server and in the mobile device application.
- DeviceInformationCheckError - Interface in ch.nevis.mobile.sdk.api.operation
-
The error that can occur with the
DeviceInformationCheck
operation. - DeviceInformationCheckError.ClockSkewTooBig - Interface in ch.nevis.mobile.sdk.api.operation
-
The clocks on the mobile and on the server are too apart and the server refused to validate the JWS sent to modify the device information.
- DeviceInformationCheckError.DeviceProtectionError - Interface in ch.nevis.mobile.sdk.api.operation
-
An error that indicates that some form of tampering was found in the application.
- DeviceInformationCheckError.Forbidden - Interface in ch.nevis.mobile.sdk.api.operation
-
The SDK could not access the credentials in the backend.
- DeviceInformationCheckError.NetworkError - Interface in ch.nevis.mobile.sdk.api.operation
-
A network error occurred.
- DeviceInformationCheckError.NoDeviceLockError - Interface in ch.nevis.mobile.sdk.api.operation
-
The android device has no secure lock screen.
- DeviceInformationCheckError.OperationNotSupportedByBackend - Interface in ch.nevis.mobile.sdk.api.operation
-
The backend does not support the retrieval of credentials.
- DeviceInformationCheckResult - Interface in ch.nevis.mobile.sdk.api.operation
-
This is the result of the
DeviceInformationCheck
operation. - DeviceInformationMismatch - Interface in ch.nevis.mobile.sdk.api.operation
-
The configuration mismatches between the server and the mobile device application.
- DeviceInformationMismatch.DeviceNameMismatch - Interface in ch.nevis.mobile.sdk.api.operation
-
There is a mismatch between the name of the device in the server and the one in the mobile device application.
- DeviceInformationMismatch.FcmRegistrationTokenMismatch - Interface in ch.nevis.mobile.sdk.api.operation
-
There is a mismatch between the firebase registration token in the server and the one in the mobile device application.
- DeviceInformationMismatch.MissingAuthenticatorInMobileDevice - Interface in ch.nevis.mobile.sdk.api.operation
-
An authenticator is registered in the server for an account, but not in the mobile device application.
- DeviceInformationMismatch.MissingAuthenticatorInServer - Interface in ch.nevis.mobile.sdk.api.operation
-
An authenticator is registered in the mobile device application for an account, but not in the server.
- DeviceInformationMismatch.MissingDeviceInformationInMobileDevice - Interface in ch.nevis.mobile.sdk.api.operation
-
The device information for the given
DeviceInformation.IdUsernamePair
is defined in the server but not in the mobile device application. - DeviceInformationMismatch.MissingDeviceInformationInServer - Interface in ch.nevis.mobile.sdk.api.operation
-
The device information for the given
DeviceInformation.IdUsernamePair
is defined in the SDK but not in the server. - deviceInformationSync() - Method in interface ch.nevis.mobile.sdk.api.operation.Operations
-
Returns a
DeviceInformationSync
object. - DeviceInformationSync - Interface in ch.nevis.mobile.sdk.api.operation
-
The operation that can be executed to correct the
DeviceInformationMismatch
problems that were found in aDeviceInformationCheck
. - DeviceInformationSyncError - Interface in ch.nevis.mobile.sdk.api.operation
-
The error that can occur with the
DeviceInformationSync
operation. - DeviceInformationSyncError.ClockSkewTooBig - Interface in ch.nevis.mobile.sdk.api.operation
-
The clocks on the mobile and on the server are too apart and the server refused to validate the JWS sent to modify the device information.
- DeviceInformationSyncError.DeviceProtectionError - Interface in ch.nevis.mobile.sdk.api.operation
-
An error that indicates that some form of tampering was found in the application.
- DeviceInformationSyncError.NetworkError - Interface in ch.nevis.mobile.sdk.api.operation
-
A network error occurred.
- DeviceInformationSyncError.NoDeviceLockError - Interface in ch.nevis.mobile.sdk.api.operation
-
The android device has no secure lock screen.
- DeviceInformationSyncError.OperationNotSupportedByBackend - Interface in ch.nevis.mobile.sdk.api.operation
-
The backend does not support the retrieval of out-of-band operations.
- DeviceInformationSyncResult - Interface in ch.nevis.mobile.sdk.api.operation
-
This is the result of the
DeviceInformationSync
operation. - DevicePasscodePromptOptions - Interface in ch.nevis.mobile.sdk.api.operation.userverification
-
Defines the elements of the device passcode prompt (title and description).
- DevicePasscodePromptOptions.Builder - Interface in ch.nevis.mobile.sdk.api.operation.userverification
-
A builder for
DevicePasscodePromptOptions
. - DevicePasscodeUserVerificationContext - Interface in ch.nevis.mobile.sdk.api.operation.userverification
-
The object providing information about the device passcode user verification (i.e.
- DevicePasscodeUserVerificationHandler - Interface in ch.nevis.mobile.sdk.api.operation.userverification
-
The object handling the outcome of an interaction where the user provides device passcode credentials.
- devicePasscodeUserVerifier(DevicePasscodeUserVerifier) - Method in interface ch.nevis.mobile.sdk.api.operation.authcloudapi.AuthCloudApiRegistration
-
Specifies the object that will take care of the device passcode user verification.
- devicePasscodeUserVerifier(DevicePasscodeUserVerifier) - Method in interface ch.nevis.mobile.sdk.api.operation.Authentication
-
Specifies the object that will take care of the device passcode user verification.
- devicePasscodeUserVerifier(DevicePasscodeUserVerifier) - Method in interface ch.nevis.mobile.sdk.api.operation.outofband.OutOfBandAuthentication
-
Specifies the object that will take care of the device passcode user verification.
- devicePasscodeUserVerifier(DevicePasscodeUserVerifier) - Method in interface ch.nevis.mobile.sdk.api.operation.outofband.OutOfBandRegistration
-
Specifies the object that will take care of the device passcode user verification.
- devicePasscodeUserVerifier(DevicePasscodeUserVerifier) - Method in interface ch.nevis.mobile.sdk.api.operation.Registration
-
Specifies the object that will take care of the device passcode user verification.
- DevicePasscodeUserVerifier - Interface in ch.nevis.mobile.sdk.api.operation.userverification
-
The object in charge of interacting with the user to do authenticate using the device passcode (PIN, password or gesture).
- deviceResourcePath() - Method in interface ch.nevis.mobile.sdk.api.Configuration
-
Returns the device service URL path.
- deviceResourcePath(String) - Method in interface ch.nevis.mobile.sdk.api.Configuration.Builder
-
Sets the device resource path URL.
- disablePushNotifications() - Method in interface ch.nevis.mobile.sdk.api.operation.DeviceInformationChange
-
Disables the push notifications on the server side (i.e.
- dispatchChannel() - Method in interface ch.nevis.mobile.sdk.api.operation.outofband.PendingOutOfBandOperation
-
The dispatch channel used by the operation.
- DispatchChannel - Enum Class in ch.nevis.mobile.sdk.api.operation.outofband
-
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, a FCM push notification or a link.
- dispatcherValue() - Method in enum class ch.nevis.mobile.sdk.api.operation.outofband.DispatchChannel
-
The dispatcher value for this channel as defined in nevisFIDO.
- dispatchTargetId() - Method in interface ch.nevis.mobile.sdk.api.operation.DeviceInformationMismatch.MissingDeviceInformationInMobileDevice
-
The identifier of the dispatch target that is missing in the mobile device.
- dispatchTargetResourcePath() - Method in interface ch.nevis.mobile.sdk.api.Configuration
-
The dispatch target resource URL path.
- dispatchTargetResourcePath(String) - Method in interface ch.nevis.mobile.sdk.api.Configuration.Builder
-
Sets the dispatch target resource path URL.
E
- empty() - Static method in interface ch.nevis.mobile.sdk.api.util.Optional
-
Returns an empty
Optional
instance. - enrolledAccounts() - Method in interface ch.nevis.mobile.sdk.api.localdata.UserEnrollment.SdkUserEnrollment
-
Returns the objects representing the accounts that are enrolled with this authenticator.
- enrollPassword(PasswordEnrollmentContext, PasswordEnrollmentHandler) - Method in interface ch.nevis.mobile.sdk.api.operation.password.PasswordEnroller
-
The method that will be invoked till either the user provides a password that is conform with the format expected by the password policy or till the operation is canceled (through the
PasswordEnrollmentHandler.cancel()
. - enrollPin(PinEnrollmentContext, PinEnrollmentHandler) - Method in interface ch.nevis.mobile.sdk.api.operation.pin.PinEnroller
-
The method that will be invoked till either the user provides a PIN that is conform with the format specified by the
PinPolicy
or till the operation is canceled (through thePinEnrollmentHandler.cancel()
. - enrollResponse(String) - Method in interface ch.nevis.mobile.sdk.api.operation.authcloudapi.AuthCloudApiRegistration
-
Specifies the response to the Authentication Cloud API enroll request.
- errorCode() - Method in interface ch.nevis.mobile.sdk.api.operation.authcloudapi.AuthCloudApiError.OperationError
-
The FIDO UAF error that occurred.
- errorCode() - Method in interface ch.nevis.mobile.sdk.api.operation.OperationError
-
The FIDO UAF error that occurred.
- errors() - Method in interface ch.nevis.mobile.sdk.api.operation.DeviceInformationCheckResult
-
Returns the errors that occurred retrieving the configuration mismatches.
- errors() - Method in interface ch.nevis.mobile.sdk.api.operation.DeviceInformationSyncResult
-
Returns the errors that occurred resolving the configuration mismatches.
- errors() - Method in interface ch.nevis.mobile.sdk.api.operation.outofband.PendingOutOfBandOperationsResult
-
Returns the errors that occurred retrieving the pending out-of-band operations.
- execute() - Method in interface ch.nevis.mobile.sdk.api.MobileAuthenticationClientInitializer
-
Starts the creation of an instance of the
MobileAuthenticationClient
. - execute() - Method in interface ch.nevis.mobile.sdk.api.operation.Operation
-
Executes the operation asynchronously.
- execute() - Method in interface ch.nevis.mobile.sdk.api.operation.outofband.OutOfBandAuthentication
-
Executes the out-of-band authentication.
- execute() - Method in interface ch.nevis.mobile.sdk.api.operation.outofband.OutOfBandRegistration
-
Executes the out-of-band registration.
F
- facetId() - Method in interface ch.nevis.mobile.sdk.api.Configuration
-
Specifies facet ID of the application.
- facetId(String) - Method in interface ch.nevis.mobile.sdk.api.Configuration.AuthCloudBuilder
-
Sets the facet ID.
- facetId(String) - Method in interface ch.nevis.mobile.sdk.api.Configuration.Builder
-
Sets the facet ID.
- fcmRegistrationToken() - Method in interface ch.nevis.mobile.sdk.api.localdata.DeviceInformation
-
The Firebase Cloud Messaging registration token.
- fcmRegistrationToken(String) - Method in interface ch.nevis.mobile.sdk.api.localdata.DeviceInformation.Builder
-
Sets the Firebase Cloud Messaging registration token.
- fcmRegistrationToken(String) - Method in interface ch.nevis.mobile.sdk.api.operation.DeviceInformationChange
-
Specifies the new Firebase Cloud Messaging registration token.
- fcmRegistrationTokenInMobileDevice() - Method in interface ch.nevis.mobile.sdk.api.operation.DeviceInformationMismatch.FcmRegistrationTokenMismatch
-
The firebase registration token in the mobile device application (that is, as returned by
DeviceInformation.fcmRegistrationToken()
throughLocalData.deviceInformation()
). - fcmRegistrationTokenInServer() - Method in interface ch.nevis.mobile.sdk.api.operation.DeviceInformationMismatch.FcmRegistrationTokenMismatch
-
The firebase registration token in the server.
- FidoErrorCode - Enum Class in ch.nevis.mobile.sdk.api.operation
-
Collection error codes based on the FIDO UAF client error codes.
- FINGERPRINT_AUTHENTICATOR_AAID - Static variable in interface ch.nevis.mobile.sdk.api.localdata.Authenticator
-
The AAID of the Fingerprint authenticator.
- FingerprintUserVerificationContext - Interface in ch.nevis.mobile.sdk.api.operation.userverification
-
The object providing information about the fingerprint user verification (i.e.
- FingerprintUserVerificationError - Interface in ch.nevis.mobile.sdk.api.operation.userverification
-
The recoverable error that can occur when verifying the user with fingerprint.
- FingerprintUserVerificationHandler - Interface in ch.nevis.mobile.sdk.api.operation.userverification
-
The object handling the outcome of an interaction where the user provides fingerprint credentials.
- fingerprintUserVerifier(FingerprintUserVerifier) - Method in interface ch.nevis.mobile.sdk.api.operation.authcloudapi.AuthCloudApiRegistration
-
Specifies the object that will take care of the fingerprint user verification.
- fingerprintUserVerifier(FingerprintUserVerifier) - Method in interface ch.nevis.mobile.sdk.api.operation.Authentication
-
Specifies the object that will take care of the fingerprint user verification.
- fingerprintUserVerifier(FingerprintUserVerifier) - Method in interface ch.nevis.mobile.sdk.api.operation.outofband.OutOfBandAuthentication
-
Specifies the object that will take care of the fingerprint user verification.
- fingerprintUserVerifier(FingerprintUserVerifier) - Method in interface ch.nevis.mobile.sdk.api.operation.outofband.OutOfBandRegistration
-
Specifies the object that will take care of the fingerprint user verification.
- fingerprintUserVerifier(FingerprintUserVerifier) - Method in interface ch.nevis.mobile.sdk.api.operation.Registration
-
Specifies the object that will take care of the fingerprint user verification.
- FingerprintUserVerifier - Interface in ch.nevis.mobile.sdk.api.operation.userverification
-
The object in charge of interacting with the user to do fingerprint authentication.
G
- get() - Method in interface ch.nevis.mobile.sdk.api.util.Optional
-
If a value is present in this
Optional
, returns the value, otherwise throwsNoSuchElementException
.
H
- hostname(String) - Method in interface ch.nevis.mobile.sdk.api.Configuration.AuthCloudBuilder
-
Sets the hostname of your Nevis Authentication Cloud.
- HttpOperation<T extends HttpOperation> - Interface in ch.nevis.mobile.sdk.api.operation
-
An operation that requires sending HTTP requests to the backend.
I
- id() - Method in interface ch.nevis.mobile.sdk.api.localdata.DeviceInformation.IdUsernamePair
-
The ID of the generic credential containing the dispatch target information (the
dispatch_target_
prefix is removed). - idUsernamePair() - Method in interface ch.nevis.mobile.sdk.api.operation.DeviceInformationMismatch.MissingDeviceInformationInServer
-
The
DeviceInformation.IdUsernamePair
that is missing in the server. - idUsernamePairs() - Method in interface ch.nevis.mobile.sdk.api.localdata.DeviceInformation
-
Returns the identifiers of the generic credentials containing the dispatch target information in nevisIDM and the associated username.
- initialDelayInSeconds() - Method in interface ch.nevis.mobile.sdk.api.operation.RetryPolicy.Exponential
-
The delay to be waited before executing the first retry.
- initialDelayInSeconds(long) - Method in interface ch.nevis.mobile.sdk.api.operation.RetryPolicy.Exponential.Builder
-
Sets the initial delay in seconds.
- InitializationError - Interface in ch.nevis.mobile.sdk.api
-
Collection of
MobileAuthenticationClient
initialization error codes. - InitializationError.DeviceProtectionError - Interface in ch.nevis.mobile.sdk.api
-
An error that indicates that some form of tampering was found in the application.
- InitializationError.HardwareError - Interface in ch.nevis.mobile.sdk.api
-
Secure hardware is not available on this device or an error occurred checking the hardware of the device.
- InitializationError.LockScreenHasChangedError - Interface in ch.nevis.mobile.sdk.api
-
User has changed the lock screen configuration of the device and the credentials were created using an SDK previous to 1.7.
- InitializationError.NoDeviceLockError - Interface in ch.nevis.mobile.sdk.api
-
The android device has no secure lock screen.
- InitializationError.RootedError - Interface in ch.nevis.mobile.sdk.api
-
The device is rooted.
- initializer() - Static method in interface ch.nevis.mobile.sdk.api.MobileAuthenticationClientInitializer
-
Returns a new
MobileAuthenticationClientInitializer
. - INSECURE_TRANSPORT - Enum constant in enum class ch.nevis.mobile.sdk.api.operation.FidoErrorCode
-
window.location.protocol is not "https" or the DOM contains insecure mixed content.
- instance() - Static method in interface ch.nevis.mobile.sdk.api.authorization.AuthorizationProvider.EmptyAuthorizationProvider
-
Returns a singleton
AuthorizationProvider.EmptyAuthorizationProvider
instance. - instance() - Static method in interface ch.nevis.mobile.sdk.api.authorization.AuthorizationProvider.JwsAuthorizationProvider
-
Returns a singleton
AuthorizationProvider.JwsAuthorizationProvider
instance. - instance() - Static method in interface ch.nevis.mobile.sdk.api.authorization.SessionProvider.EmptySessionProvider
-
Returns a singleton
SessionProvider.EmptySessionProvider
instance. - instance() - Static method in interface ch.nevis.mobile.sdk.api.operation.RetryPolicy.NoRetry
-
Returns a
NoRetry
object. - INSUFFICIENT_AUTHENTICATOR_RESOURCES - Enum constant in enum class ch.nevis.mobile.sdk.api.operation.FidoErrorCode
-
Insufficient resources in the authenticator to perform the requested task.
- INVALID_TRANSACTION_CONTENT - Enum constant in enum class ch.nevis.mobile.sdk.api.operation.FidoErrorCode
-
Transaction content cannot be rendered, e.g.
- invalidateOnNewOsBiometrics(boolean) - Method in interface ch.nevis.mobile.sdk.api.operation.authcloudapi.AuthCloudApiRegistration
-
Specifies whether the authenticator must be invalidated if the user adds new biometric credentials in the OS settings.
- invalidateOnNewOsBiometrics(boolean) - Method in interface ch.nevis.mobile.sdk.api.operation.outofband.OutOfBandRegistration
-
Specifies whether the authenticator must be invalidated if the user adds new biometric credentials in the OS settings.
- invalidateOnNewOsBiometrics(boolean) - Method in interface ch.nevis.mobile.sdk.api.operation.Registration
-
Specifies whether the authenticator must be invalidated if the user adds new biometric credentials in the OS settings.
- isEnrolled() - Method in interface ch.nevis.mobile.sdk.api.localdata.UserEnrollment.OsUserEnrollment
-
For the biometric authenticator, if the user is enrolled with a Class 3 (formerly strong) biometric sensor, returns
true
. - isEnrolled(String) - Method in interface ch.nevis.mobile.sdk.api.localdata.UserEnrollment.SdkUserEnrollment
-
Tells whether a given user is enrolled or not
- isEnrolledWithClass2OrClass3Sensor() - Method in interface ch.nevis.mobile.sdk.api.localdata.UserEnrollment.OsUserEnrollment
-
For the biometric authenticator, returns
true
if the user is enrolled in the OS with at least one Class 2 (formerly weak) or Class 3 (formerly strong) biometric sensor,false
otherwise. - isPolicyCompliant(String) - Method in interface ch.nevis.mobile.sdk.api.operation.selection.AuthenticatorSelectionContext
-
Returns whether the provided authenticator is compliant with the policy of the server.
- isPolicyCompliant(String, String) - Method in interface ch.nevis.mobile.sdk.api.operation.selection.AccountSelectionContext
-
Returns whether the specified account with the provided authenticator is compliant with the policy of the server.
- isPresent() - Method in interface ch.nevis.mobile.sdk.api.util.Optional
-
Return
true
if there is a value present, otherwisefalse
. - isRegistered(String) - Method in interface ch.nevis.mobile.sdk.api.localdata.RegistrationInfo
-
Returns true if the provided user is registered and
false
otherwise. - isSupportedByHardware() - Method in interface ch.nevis.mobile.sdk.api.localdata.Authenticator
-
Returns whether the device has hardware supporting this authenticator or not.
- isSupportedByOs() - Method in interface ch.nevis.mobile.sdk.api.localdata.Authenticator
-
Returns whether the Operating System supports this authenticator or not.
J
- JOSE - Enum constant in enum class ch.nevis.mobile.sdk.api.operation.outofband.ContentType
-
JOSE content type.
- json(String) - Method in interface ch.nevis.mobile.sdk.api.operation.outofband.OutOfBandPayloadDecode
-
Specifies the JSON to be decoded.
- JSON - Enum constant in enum class ch.nevis.mobile.sdk.api.operation.outofband.ContentType
-
JSON content type.
- jwt() - Method in interface ch.nevis.mobile.sdk.api.authorization.AuthorizationProvider.JwtAuthorizationProvider
-
Returns the JWT.
- jwt() - Method in interface ch.nevis.mobile.sdk.api.authorization.SessionProvider.JwtSessionProvider
-
Returns the JWT.
- Jwt - Interface in ch.nevis.mobile.sdk.api.authorization
-
An object representing a JWT token as described in the RFC 7519.
K
- KEY_DISAPPEARED_PERMANENTLY - Enum constant in enum class ch.nevis.mobile.sdk.api.operation.FidoErrorCode
-
The UAuth key disappeared from the authenticator and cannot be restored.
- keyId() - Method in interface ch.nevis.mobile.sdk.api.operation.DeviceInformationMismatch.MissingAuthenticatorInMobileDevice
-
The key ID of the FIDO UAF credentials associated with the missing authenticator.
- keyId() - Method in interface ch.nevis.mobile.sdk.api.operation.DeviceInformationMismatch.MissingAuthenticatorInServer
-
The key ID of the FIDO UAF credentials associated with the missing authenticator.
L
- lastRecoverableError() - Method in interface ch.nevis.mobile.sdk.api.operation.password.PasswordChangeContext
-
The object describing the latest recoverable error (if any).
- lastRecoverableError() - Method in interface ch.nevis.mobile.sdk.api.operation.password.PasswordEnrollmentContext
-
The last recoverable error (if any).
- lastRecoverableError() - Method in interface ch.nevis.mobile.sdk.api.operation.pin.PinChangeContext
-
The object describing the latest recoverable error (if any).
- lastRecoverableError() - Method in interface ch.nevis.mobile.sdk.api.operation.pin.PinEnrollmentContext
-
The last recoverable error (if any).
- lastRecoverableError() - Method in interface ch.nevis.mobile.sdk.api.operation.userverification.FingerprintUserVerificationContext
-
When a recoverable error occurred during the last credential verification, this method returns the object describing the last error.
- lastRecoverableError() - Method in interface ch.nevis.mobile.sdk.api.operation.userverification.PasswordUserVerificationContext
-
When a recoverable error occurred during the last credential verification, this method returns the object describing the last error.
- lastRecoverableError() - Method in interface ch.nevis.mobile.sdk.api.operation.userverification.PinUserVerificationContext
-
When a recoverable error occurred during the last credential verification, this method returns the object describing the last error.
- LINK - Enum constant in enum class ch.nevis.mobile.sdk.api.operation.outofband.DispatchChannel
-
A link (Universal Link, App Links, etc.) was used for the out-of-band operation.
- listenForOsCredentials() - Method in interface ch.nevis.mobile.sdk.api.operation.userverification.FingerprintUserVerificationHandler
-
When this method is invoked, the SDK will wait for the user to provide credentials.
- listenForOsCredentials(BiometricPromptOptions) - Method in interface ch.nevis.mobile.sdk.api.operation.userverification.BiometricUserVerificationHandler
-
When this method is invoked, the SDK will invoke the operating system prompt to ask the user to provide credentials.
- listenForOsCredentials(DevicePasscodePromptOptions) - Method in interface ch.nevis.mobile.sdk.api.operation.userverification.DevicePasscodeUserVerificationHandler
-
When this method is invoked, the SDK will invoke the operating system prompt to ask the user to provide credentials.
- localData() - Method in interface ch.nevis.mobile.sdk.api.MobileAuthenticationClient
-
Returns the object that can be used to get information about the data (authenticators, device information) managed by the SDK.
- LocalData - Interface in ch.nevis.mobile.sdk.api.localdata
-
An interface that provides information about the information that is stored locally in the SDK.
M
- major() - Method in interface ch.nevis.mobile.sdk.api.metadata.Version
-
Gives back the
major
field of the version, such as 1 in version 1.5.3.4. - maximumDelayInSeconds() - Method in interface ch.nevis.mobile.sdk.api.operation.RetryPolicy.Exponential
-
The maximum time interval of the delay in seconds.
- maximumDelayInSeconds(long) - Method in interface ch.nevis.mobile.sdk.api.operation.RetryPolicy.Exponential.Builder
-
Sets the maximum time interval of the delay in seconds.
- maxLength() - Method in interface ch.nevis.mobile.sdk.api.operation.pin.PinPolicy
-
The maximum length of the PIN.
- maxLength(int) - Method in interface ch.nevis.mobile.sdk.api.operation.pin.PinPolicy.Builder
-
Sets the maximum length of the PIN.
- maxRetries() - Method in interface ch.nevis.mobile.sdk.api.operation.RetryPolicy.Constant
-
The maximum number of retries
- maxRetries() - Method in interface ch.nevis.mobile.sdk.api.operation.RetryPolicy.Exponential
-
The maximum number of retries
- maxRetries(int) - Method in interface ch.nevis.mobile.sdk.api.operation.RetryPolicy.Constant.Builder
-
Sets the maximum number of retries
- maxRetries(int) - Method in interface ch.nevis.mobile.sdk.api.operation.RetryPolicy.Exponential.Builder
-
Sets the maximum number of retries
- message() - Method in interface ch.nevis.mobile.sdk.api.operation.userverification.FingerprintUserVerificationError
-
If available, this returns a localized message describing the error that can be presented to the end-user.
- MetaData - Interface in ch.nevis.mobile.sdk.api.metadata
-
An interface with
static
methods only that provides additional information about the Nevis Mobile Authentication SDK. - minLength() - Method in interface ch.nevis.mobile.sdk.api.operation.pin.PinPolicy
-
The minimum length of the PIN.
- minLength(int) - Method in interface ch.nevis.mobile.sdk.api.operation.pin.PinPolicy.Builder
-
Sets the minimum length of the PIN.
- minor() - Method in interface ch.nevis.mobile.sdk.api.metadata.Version
-
Gives back the
minor
field of the version, such as 5 in version 1.5.3.4. - mismatches() - Method in interface ch.nevis.mobile.sdk.api.operation.DeviceInformationCheckResult
-
Returns the mismatches configuration mismatches between the mobile SDK.
- mismatches(Set<DeviceInformationMismatch>) - Method in interface ch.nevis.mobile.sdk.api.operation.DeviceInformationSync
-
Specifies the configuration mismatches to be fixed.
- MobileAuthenticationClient - Interface in ch.nevis.mobile.sdk.api
-
The
MobileAuthenticationClient
interface represents the entry point to the SDK. - MobileAuthenticationClientError - Interface in ch.nevis.mobile.sdk.api
-
The parent of all the errors that can be returned.
- MobileAuthenticationClientInitializer - Interface in ch.nevis.mobile.sdk.api
-
The class that creates and initializes asynchronously an instance of
MobileAuthenticationClient
. - mobileAuthenticationVersion() - Static method in interface ch.nevis.mobile.sdk.api.metadata.MetaData
-
Gives back the version of the Nevis Mobile Authentication SDK.
- multiplier() - Method in interface ch.nevis.mobile.sdk.api.operation.RetryPolicy.Exponential
-
The multiplier of the delay interval.
- multiplier(double) - Method in interface ch.nevis.mobile.sdk.api.operation.RetryPolicy.Exponential.Builder
-
Sets the multiplier of the delay interval
N
- name() - Method in interface ch.nevis.mobile.sdk.api.localdata.DeviceInformation
-
A user-friendly name to identify this device, for instance
My Private Android Phone
. - name(String) - Method in interface ch.nevis.mobile.sdk.api.localdata.DeviceInformation.Builder
-
Sets the user-friendly name of the device.
- name(String) - Method in interface ch.nevis.mobile.sdk.api.operation.DeviceInformationChange
-
Specifies the new name of the device information.
- nameInMobileDevice() - Method in interface ch.nevis.mobile.sdk.api.operation.DeviceInformationMismatch.DeviceNameMismatch
-
The name of the device in the mobile application (that is, as returned by
DeviceInformation.name()
throughLocalData.deviceInformation()
). - nameInServer() - Method in interface ch.nevis.mobile.sdk.api.operation.DeviceInformationMismatch.DeviceNameMismatch
-
The name of the device in the server.
- namesAndValues() - Method in interface ch.nevis.mobile.sdk.api.operation.RequestHeaders
-
A list containing the name of the headers and the associated values.
- networkTimeoutInSeconds() - Method in interface ch.nevis.mobile.sdk.api.Configuration
-
Time interval for network calls in seconds.
- networkTimeoutInSeconds(long) - Method in interface ch.nevis.mobile.sdk.api.Configuration.AuthCloudBuilder
-
Sets the time interval for network timeouts in seconds.
- networkTimeoutInSeconds(long) - Method in interface ch.nevis.mobile.sdk.api.Configuration.Builder
-
Sets the time interval for network timeouts in seconds.
- NO_ERROR - Enum constant in enum class ch.nevis.mobile.sdk.api.operation.FidoErrorCode
-
The operation completed with no error condition encountered.
- NO_SUITABLE_AUTHENTICATOR - Enum constant in enum class ch.nevis.mobile.sdk.api.operation.FidoErrorCode
-
No authenticator matching the authenticator policy specified in the UAFMessage is available to service the request, or the user declined to consent to the use of a suitable authenticator.
O
- of(T) - Static method in interface ch.nevis.mobile.sdk.api.util.Optional
-
Returns an
Optional
with the specified present non-null value. - ofNullable(T) - Static method in interface ch.nevis.mobile.sdk.api.util.Optional
-
Returns an
Optional
describing the specified value, if non-null, otherwise returns an emptyOptional
. - onAuthentication(Consumer<OutOfBandAuthentication>) - Method in interface ch.nevis.mobile.sdk.api.operation.outofband.OutOfBandOperation
-
Specifies the object that will handle the
OutOfBandAuthentication
object associated with theOutOfBandPayload
. - onError(Consumer<InitializationError>) - Method in interface ch.nevis.mobile.sdk.api.MobileAuthenticationClientInitializer
-
The object invoked when an error occurs after invoking
MobileAuthenticationClientInitializer.execute()
. - onError(Consumer<AuthCloudApiError>) - Method in interface ch.nevis.mobile.sdk.api.operation.authcloudapi.AuthCloudApiRegistration
-
Specifies the object that will be invoked if the registration failed.
- onError(Consumer<AuthenticationError>) - Method in interface ch.nevis.mobile.sdk.api.operation.Authentication
-
Specifies the object that will be invoked if the authentication failed.
- onError(Consumer<OperationError>) - Method in interface ch.nevis.mobile.sdk.api.operation.Deregistration
-
Specifies the object that will be invoked if the deregistration failed.
- onError(Consumer<OperationError>) - Method in interface ch.nevis.mobile.sdk.api.operation.outofband.OutOfBandAuthentication
-
Specifies the object that will be invoked if the authentication failed.
- onError(Consumer<OperationError>) - Method in interface ch.nevis.mobile.sdk.api.operation.outofband.OutOfBandRegistration
-
Specifies the object that will be invoked if the registration failed.
- onError(Consumer<OperationError>) - Method in interface ch.nevis.mobile.sdk.api.operation.Registration
-
Specifies the object that will be invoked if the registration failed.
- onError(Consumer<DeviceInformationChangeError>) - Method in interface ch.nevis.mobile.sdk.api.operation.DeviceInformationChange
-
Specifies the object that will be invoked if the device information update failed.
- onError(Consumer<OutOfBandOperationError>) - Method in interface ch.nevis.mobile.sdk.api.operation.outofband.OutOfBandOperation
-
Specifies the object that will be invoked if there was an error handling the
OutOfBandPayload
: the payload could not be decrypted, the server could not be reached, the server returned an error, etc. - onError(Consumer<OutOfBandPayloadError>) - Method in interface ch.nevis.mobile.sdk.api.operation.outofband.OutOfBandPayloadDecode
-
Specifies the object that will be invoked if the
OutOfBandPayload
could not be decoded. - onError(Consumer<PasswordChangeError>) - Method in interface ch.nevis.mobile.sdk.api.operation.password.PasswordChange
-
The method invoked when the password could not be changed: the password was not enrolled, the password is locked or the operation was canceled.
- onError(Consumer<PinChangeError>) - Method in interface ch.nevis.mobile.sdk.api.operation.pin.PinChange
-
The method invoked when the PIN could not be changed: the PIN was not enrolled, the PIN is locked or the operation was canceled.
- onRegistration(Consumer<OutOfBandRegistration>) - Method in interface ch.nevis.mobile.sdk.api.operation.outofband.OutOfBandOperation
-
Specifies the object that will handle the
OutOfBandRegistration
object associated with the out-of-band payload. - onResult(Consumer<DeviceInformationCheckResult>) - Method in interface ch.nevis.mobile.sdk.api.operation.DeviceInformationCheck
-
Specifies the object that will be invoked with the
DeviceInformationCheckResult
containing the configuration mismatches an errors (if any) that occurred. - onResult(Consumer<DeviceInformationSyncResult>) - Method in interface ch.nevis.mobile.sdk.api.operation.DeviceInformationSync
-
Specifies the object that will be invoked when the operation completes.
- onResult(Consumer<PendingOutOfBandOperationsResult>) - Method in interface ch.nevis.mobile.sdk.api.operation.outofband.PendingOutOfBandOperations
-
Specifies the object that will be invoked with the
PendingOutOfBandOperationsResult
containing the pending out-of-band operations for this application and the errors (if any) that occurred retrieving the operations. - onSuccess(Consumer<AuthorizationProvider>) - Method in interface ch.nevis.mobile.sdk.api.operation.Authentication
-
Specifies the object that will be invoked if the authentication was successful.
- onSuccess(Consumer<AuthorizationProvider>) - Method in interface ch.nevis.mobile.sdk.api.operation.outofband.OutOfBandAuthentication
-
Specifies the object that will be invoked if the authentication was successful.
- onSuccess(Consumer<MobileAuthenticationClient>) - Method in interface ch.nevis.mobile.sdk.api.MobileAuthenticationClientInitializer
-
The method invoked when the
MobileAuthenticationClient
could be successfully built after invokingMobileAuthenticationClientInitializer.execute()
. - onSuccess(Consumer<OutOfBandPayload>) - Method in interface ch.nevis.mobile.sdk.api.operation.outofband.OutOfBandPayloadDecode
-
Specifies the object that will be invoked if the
OutOfBandPayload
was decoded. - onSuccess(Runnable) - Method in interface ch.nevis.mobile.sdk.api.operation.authcloudapi.AuthCloudApiRegistration
-
Specifies the object that will be invoked if the registration completed successfully.
- onSuccess(Runnable) - Method in interface ch.nevis.mobile.sdk.api.operation.Deregistration
-
Specifies the object that will be invoked if the authenticator was deleted successfully.
- onSuccess(Runnable) - Method in interface ch.nevis.mobile.sdk.api.operation.DeviceInformationChange
-
Specifies the object that will be invoked if the device information for the user was updated successfully.
- onSuccess(Runnable) - Method in interface ch.nevis.mobile.sdk.api.operation.outofband.OutOfBandRegistration
-
Specifies the object that will be invoked if the registration completed successfully.
- onSuccess(Runnable) - Method in interface ch.nevis.mobile.sdk.api.operation.password.PasswordChange
-
Specifies the object that will be invoked if the password was successfully modified.
- onSuccess(Runnable) - Method in interface ch.nevis.mobile.sdk.api.operation.pin.PinChange
-
Specifies the object that will be invoked if the PIN was successfully modified.
- onSuccess(Runnable) - Method in interface ch.nevis.mobile.sdk.api.operation.Registration
-
Specifies the object that will be invoked if the registration completed successfully.
- onValidCredentialsProvided() - Method in interface ch.nevis.mobile.sdk.api.operation.password.PasswordEnroller
-
This method is invoked when valid password credentials were provided during registration.
- onValidCredentialsProvided() - Method in interface ch.nevis.mobile.sdk.api.operation.pin.PinEnroller
-
This method is invoked when valid PIN credentials were provided during registration.
- onValidCredentialsProvided() - Method in interface ch.nevis.mobile.sdk.api.operation.userverification.BiometricUserVerifier
-
This method is invoked when either valid biometric credentials were provided and verified locally.
- onValidCredentialsProvided() - Method in interface ch.nevis.mobile.sdk.api.operation.userverification.DevicePasscodeUserVerifier
-
This method is invoked when either valid device passcode credentials were provided and verified locally.
- onValidCredentialsProvided() - Method in interface ch.nevis.mobile.sdk.api.operation.userverification.FingerprintUserVerifier
-
This method is invoked when valid fingerprint credentials were provided and verified locally.
- onValidCredentialsProvided() - Method in interface ch.nevis.mobile.sdk.api.operation.userverification.PasswordUserVerifier
-
This method is invoked when valid password credentials were provided and verified locally.
- onValidCredentialsProvided() - Method in interface ch.nevis.mobile.sdk.api.operation.userverification.PinUserVerifier
-
This method is invoked when valid PIN credentials were provided and verified locally.
- Operation - Interface in ch.nevis.mobile.sdk.api.operation
-
The generic interface representing an operation returned by
Operations
. - OperationError - Interface in ch.nevis.mobile.sdk.api.operation
-
An error occurred during registration, authentication or deregistration.
- OperationError.ClockSkewTooBig - Interface in ch.nevis.mobile.sdk.api.operation
-
The clocks on the mobile and on the server are too apart and the server refused to validate the JWS.
- OperationError.DeviceProtectionError - Interface in ch.nevis.mobile.sdk.api.operation
-
An error that indicates that some form of tampering was found in the application.
- OperationError.NetworkError - Interface in ch.nevis.mobile.sdk.api.operation
-
A network error occurred while redeeming the token: either the server was not reachable or it returned an HTTP error.
- OperationError.NoDeviceLockError - Interface in ch.nevis.mobile.sdk.api.operation
-
The android device has no secure lock screen.
- OperationError.OperationNotSupportedByBackend - Interface in ch.nevis.mobile.sdk.api.operation
-
The backend does not support using the
AuthorizationProvider.JwsAuthorizationProvider
. - OperationError.UserAlreadyRegisteredInAnotherServer - Interface in ch.nevis.mobile.sdk.api.operation
-
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.
- OperationError.UserNotRegisteredInServer - Interface in ch.nevis.mobile.sdk.api.operation
-
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. - operations() - Method in interface ch.nevis.mobile.sdk.api.MobileAuthenticationClient
-
Returns the object that can be used to invoke operations against the server.
- operations() - Method in interface ch.nevis.mobile.sdk.api.operation.outofband.PendingOutOfBandOperationsResult
-
Returns the out-of-band operations of the device that have not been redeemed, nor timed-out.
- Operations - Interface in ch.nevis.mobile.sdk.api.operation
-
The interface used to obtain operation objects (registration, deregistration, authentication...).
- Optional<T> - Interface in ch.nevis.mobile.sdk.api.util
-
A container object which may or may not contain a non-null value.
- orElse(T) - Method in interface ch.nevis.mobile.sdk.api.util.Optional
-
Return the value if present, otherwise return
other
. - OsAuthenticationListenHandler - Interface in ch.nevis.mobile.sdk.api.operation.userverification
-
An object that can be used to resume listening for OS credentials (i.e.
- OutOfBandAuthentication - Interface in ch.nevis.mobile.sdk.api.operation.outofband
-
The operation handling an out-of-band authentication.
- outOfBandOperation() - Method in interface ch.nevis.mobile.sdk.api.operation.Operations
-
Returns a
OutOfBandOperation
object. - OutOfBandOperation - Interface in ch.nevis.mobile.sdk.api.operation.outofband
-
The operation managing an
OutOfBandPayload
. - OutOfBandOperationError - Interface in ch.nevis.mobile.sdk.api.operation.outofband
-
The error that can occur when the processing of a
OutOfBandPayload
fails. - OutOfBandOperationError.DeviceProtectionError - Interface in ch.nevis.mobile.sdk.api.operation.outofband
-
An error that indicates that some form of tampering was found in the application.
- OutOfBandOperationError.NetworkError - Interface in ch.nevis.mobile.sdk.api.operation.outofband
-
A network error occurred while redeeming the token: either the server was not reachable or it returned an HTTP error.
- OutOfBandOperationError.NoDeviceLockError - Interface in ch.nevis.mobile.sdk.api.operation.outofband
-
The android device has no secure lock screen.
- OutOfBandOperationError.TokenAlreadyRedeemed - Interface in ch.nevis.mobile.sdk.api.operation.outofband
-
The token was already redeemed.
- OutOfBandOperationError.TokenExpired - Interface in ch.nevis.mobile.sdk.api.operation.outofband
-
The token has expired.
- OutOfBandPayload - Interface in ch.nevis.mobile.sdk.api.operation.outofband
-
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).
- outOfBandPayloadDecode() - Method in interface ch.nevis.mobile.sdk.api.operation.Operations
-
Returns an
OutOfBandPayloadDecode
object. - OutOfBandPayloadDecode - Interface in ch.nevis.mobile.sdk.api.operation.outofband
-
The object that decodes an
OutOfBandPayload
from aString
in JSON format or a base64 URL encodedString
representing the JSON. - OutOfBandPayloadError - Interface in ch.nevis.mobile.sdk.api.operation.outofband
-
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.
- OutOfBandPayloadError.DecryptionError - Interface in ch.nevis.mobile.sdk.api.operation.outofband
-
The encrypted contents of the out-of-band payload could not be decrypted.
- OutOfBandPayloadError.DeviceProtectionError - Interface in ch.nevis.mobile.sdk.api.operation.outofband
-
An error that indicates that some form of tampering was found in the application.
- OutOfBandPayloadError.MalformedPayload - Interface in ch.nevis.mobile.sdk.api.operation.outofband
-
A violation of the out-of-band payload (contents of
OutOfBandPayload
occurred. - OutOfBandPayloadError.NoDeviceLockError - Interface in ch.nevis.mobile.sdk.api.operation.outofband
-
The android device has no secure lock screen.
- OutOfBandRegistration - Interface in ch.nevis.mobile.sdk.api.operation.outofband
-
The operation handling an out-of-band registration.
P
- packageInfo() - Method in interface ch.nevis.mobile.sdk.api.Configuration
-
The PackageInfo object of the main
Activity
. - packageInfo(PackageInfo) - Method in interface ch.nevis.mobile.sdk.api.Configuration.AuthCloudBuilder
-
Sets the package information.
- packageInfo(PackageInfo) - Method in interface ch.nevis.mobile.sdk.api.Configuration.Builder
-
Sets the package information.
- password(char[]) - Method in interface ch.nevis.mobile.sdk.api.operation.password.PasswordEnrollmentHandler
-
Specify the password to be enrolled.
- PASSWORD_AUTHENTICATOR_AAID - Static variable in interface ch.nevis.mobile.sdk.api.localdata.Authenticator
-
The AAID of the password authenticator.
- PasswordAuthenticatorProtectionStatus - Interface in ch.nevis.mobile.sdk.api.operation.password
-
The object describing the password authenticator protection status.
- PasswordAuthenticatorProtectionStatus.LastAttemptFailed - Interface in ch.nevis.mobile.sdk.api.operation.password
-
And invalid password was provided previously.
- PasswordAuthenticatorProtectionStatus.LockedOut - Interface in ch.nevis.mobile.sdk.api.operation.password
-
The authenticator is locked and cannot be used.
- PasswordAuthenticatorProtectionStatus.Unlocked - Interface in ch.nevis.mobile.sdk.api.operation.password
-
The authenticator is unlocked and can be used.
- passwordChange() - Method in interface ch.nevis.mobile.sdk.api.operation.Operations
-
Returns a
PasswordChange
object. - PasswordChange - Interface in ch.nevis.mobile.sdk.api.operation.password
-
The object that can be used to change the password.
- PasswordChangeContext - Interface in ch.nevis.mobile.sdk.api.operation.password
-
The object providing some contextual information during password change.
- PasswordChangeError - Interface in ch.nevis.mobile.sdk.api.operation.password
-
The error returned when the password change failed.
- PasswordChangeError.DeviceProtectionError - Interface in ch.nevis.mobile.sdk.api.operation.password
-
An error that indicates that some form of tampering was found in the application.
- PasswordChangeError.NoDeviceLockError - Interface in ch.nevis.mobile.sdk.api.operation.password
-
The android device has no secure lock screen.
- PasswordChangeError.PasswordLocked - Interface in ch.nevis.mobile.sdk.api.operation.password
-
The password was locked because of too many failures.
- PasswordChangeError.PasswordNotEnrolled - Interface in ch.nevis.mobile.sdk.api.operation.password
-
The specified user in
PasswordChange.username(String)
does not have an enrolled password. - PasswordChangeError.UserCanceled - Interface in ch.nevis.mobile.sdk.api.operation.password
-
The password change was canceled.
- PasswordChangeHandler - Interface in ch.nevis.mobile.sdk.api.operation.password
-
The object handling the old and new password provided by the end-user.
- passwordChanger(PasswordChanger) - Method in interface ch.nevis.mobile.sdk.api.operation.password.PasswordChange
-
Specifies the object that will be informed of the potential recoverable errors and is responsible for obtaining the password from the end-user.
- PasswordChanger - Interface in ch.nevis.mobile.sdk.api.operation.password
-
The object in charge of password change.
- PasswordChangeRecoverableError - Interface in ch.nevis.mobile.sdk.api.operation.password
-
The recoverable error that can occur when changing a password.
- PasswordChangeRecoverableError.CustomValidationError - Interface in ch.nevis.mobile.sdk.api.operation.password
-
The provided new password has failed the validation done in
PasswordPolicy.validatePasswordForPasswordChange(char[], Runnable, Consumer)
. - PasswordChangeRecoverableError.CustomValidationError.Builder - Interface in ch.nevis.mobile.sdk.api.operation.password
-
A builder for
CustomValidationError
. - PasswordChangeRecoverableError.InvalidPassword - Interface in ch.nevis.mobile.sdk.api.operation.password
-
The provided old password is not valid.
- PasswordChangeRecoverableError.OldPasswordEqualsNewPassword - Interface in ch.nevis.mobile.sdk.api.operation.password
-
The old and new passwords are equal.
- passwordEnroller(PasswordEnroller) - Method in interface ch.nevis.mobile.sdk.api.operation.authcloudapi.AuthCloudApiRegistration
-
Specifies the object that will take care of enrolling the password of the authenticator.
- passwordEnroller(PasswordEnroller) - Method in interface ch.nevis.mobile.sdk.api.operation.outofband.OutOfBandRegistration
-
Specifies the object that will take care of enrolling the password of the authenticator.
- passwordEnroller(PasswordEnroller) - Method in interface ch.nevis.mobile.sdk.api.operation.Registration
-
Specifies the object that will take care of enrolling the password of the authenticator.
- PasswordEnroller - Interface in ch.nevis.mobile.sdk.api.operation.password
-
The object in charge of password enrollment.
- PasswordEnrollmentContext - Interface in ch.nevis.mobile.sdk.api.operation.password
-
The object providing some contextual information during password enrollment.
- PasswordEnrollmentError - Interface in ch.nevis.mobile.sdk.api.operation.password
-
The object that informs that an error occurred during password enrollment.
- PasswordEnrollmentError.Builder - Interface in ch.nevis.mobile.sdk.api.operation.password
-
A builder for
PasswordEnrollmentError
. - PasswordEnrollmentHandler - Interface in ch.nevis.mobile.sdk.api.operation.password
-
The object handling the password to be enrolled.
- passwordPolicy() - Method in interface ch.nevis.mobile.sdk.api.operation.password.PasswordChanger
-
Returns the object defining the constraints of the password (minimum length, required special characters, etc.) to be changed.
- passwordPolicy() - Method in interface ch.nevis.mobile.sdk.api.operation.password.PasswordEnroller
-
Returns the object defining the constraints of the password (minimum length, required special characters, etc.) that will be enrolled.
- passwordPolicy() - Method in interface ch.nevis.mobile.sdk.api.operation.password.PasswordPolicyProvider
-
Returns the object defining the constraints of the password (minimum length, required special characters, etc.).
- PasswordPolicy - Interface in ch.nevis.mobile.sdk.api.operation.password
-
The object defining whether the password provided by a user during enrollment or when changing it is valid.
- PasswordPolicyProvider - Interface in ch.nevis.mobile.sdk.api.operation.password
-
An object defining the
PasswordPolicy
- passwords(char[], char[]) - Method in interface ch.nevis.mobile.sdk.api.operation.password.PasswordChangeHandler
-
Specify the old password and the new password.
- PasswordUserVerificationContext - Interface in ch.nevis.mobile.sdk.api.operation.userverification
-
The object providing information about the password user verification (i.e.
- PasswordUserVerificationError - Interface in ch.nevis.mobile.sdk.api.operation.userverification
-
The recoverable error that can occur when verifying the user with a password.
- PasswordUserVerificationError.InvalidPassword - Interface in ch.nevis.mobile.sdk.api.operation.userverification
-
The error that occurs when the user provides a bad password.
- PasswordUserVerificationHandler - Interface in ch.nevis.mobile.sdk.api.operation.userverification
-
The object handling the outcome of an interaction where the user provides password credentials.
- passwordUserVerifier(PasswordUserVerifier) - Method in interface ch.nevis.mobile.sdk.api.operation.Authentication
-
Specifies the object that will take care of the password user verification.
- passwordUserVerifier(PasswordUserVerifier) - Method in interface ch.nevis.mobile.sdk.api.operation.outofband.OutOfBandAuthentication
-
Specifies the object that will take care of the password user verification.
- PasswordUserVerifier - Interface in ch.nevis.mobile.sdk.api.operation.userverification
-
The object in charge of interacting with the user to do password authentication.
- patch() - Method in interface ch.nevis.mobile.sdk.api.metadata.Version
-
Gives back the
patch
field of the version, such as 3 in version 1.5.3.4. - pauseListening() - Method in interface ch.nevis.mobile.sdk.api.operation.userverification.OsAuthenticationListenHandler
-
Pauses listening for OS credentials.
- payload() - Method in interface ch.nevis.mobile.sdk.api.operation.outofband.PendingOutOfBandOperation
-
The
OutOfBandPayload
object that can be used with theOutOfBandOperation
to continue with the operation. - payload(OutOfBandPayload) - Method in interface ch.nevis.mobile.sdk.api.operation.outofband.OutOfBandOperation
-
Specifies the out-of-band payload to be handled.
- PendingOutOfBandOperation - Interface in ch.nevis.mobile.sdk.api.operation.outofband
-
The object defining a non-redeemed out-of-band operation as defined in the in the Get Device Out-of-Band Operations service.
- pendingOutOfBandOperations() - Method in interface ch.nevis.mobile.sdk.api.operation.Operations
-
Returns a
PendingOutOfBandOperations
object. - PendingOutOfBandOperations - Interface in ch.nevis.mobile.sdk.api.operation.outofband
-
The operation retrieving the out-of-band operations that have been started in the server, and must be handled by the application running the Mobile SDK in this device.
- PendingOutOfBandOperationsError - Interface in ch.nevis.mobile.sdk.api.operation.outofband
-
The error that can occur with the
PendingOutOfBandOperations
operation. - PendingOutOfBandOperationsError.ClockSkewTooBig - Interface in ch.nevis.mobile.sdk.api.operation.outofband
-
The clocks on the mobile and on the server are too apart and the server refused to validate the JWS sent to modify the device information.
- PendingOutOfBandOperationsError.DeviceProtectionError - Interface in ch.nevis.mobile.sdk.api.operation.outofband
-
An error that indicates that some form of tampering was found in the application.
- PendingOutOfBandOperationsError.NetworkError - Interface in ch.nevis.mobile.sdk.api.operation.outofband
-
A network error occurred.
- PendingOutOfBandOperationsError.NoDeviceLockError - Interface in ch.nevis.mobile.sdk.api.operation.outofband
-
The android device has no secure lock screen.
- PendingOutOfBandOperationsError.OperationNotSupportedByBackend - Interface in ch.nevis.mobile.sdk.api.operation.outofband
-
The backend does not support the retrieval of out-of-band operations.
- PendingOutOfBandOperationsResult - Interface in ch.nevis.mobile.sdk.api.operation.outofband
-
The object with the non-redeemed out-of-band operations returned by nevisFIDO in the Get Device Out-of-Band Operations service.
- pin(char[]) - Method in interface ch.nevis.mobile.sdk.api.operation.pin.PinEnrollmentHandler
-
Specify the PIN to be enrolled.
- PIN_AUTHENTICATOR_AAID - Static variable in interface ch.nevis.mobile.sdk.api.localdata.Authenticator
-
The AAID of the PIN authenticator.
- PinAuthenticatorProtectionStatus - Interface in ch.nevis.mobile.sdk.api.operation.pin
-
The object describing the PIN authenticator protection status.
- PinAuthenticatorProtectionStatus.LastAttemptFailed - Interface in ch.nevis.mobile.sdk.api.operation.pin
-
And invalid PIN was provided previously.
- PinAuthenticatorProtectionStatus.LockedOut - Interface in ch.nevis.mobile.sdk.api.operation.pin
-
The authenticator is locked and cannot be used.
- PinAuthenticatorProtectionStatus.Unlocked - Interface in ch.nevis.mobile.sdk.api.operation.pin
-
The authenticator is unlocked and can be used.
- pinChange() - Method in interface ch.nevis.mobile.sdk.api.operation.Operations
-
Returns a
PinChange
object. - PinChange - Interface in ch.nevis.mobile.sdk.api.operation.pin
-
The object that can be used to change the PIN.
- PinChangeContext - Interface in ch.nevis.mobile.sdk.api.operation.pin
-
The object providing some contextual information during PIN change.
- PinChangeError - Interface in ch.nevis.mobile.sdk.api.operation.pin
-
The error returned when the PIN change failed.
- PinChangeError.DeviceProtectionError - Interface in ch.nevis.mobile.sdk.api.operation.pin
-
An error that indicates that some form of tampering was found in the application.
- PinChangeError.NoDeviceLockError - Interface in ch.nevis.mobile.sdk.api.operation.pin
-
The android device has no secure lock screen.
- PinChangeError.PinLocked - Interface in ch.nevis.mobile.sdk.api.operation.pin
-
The PIN was locked because of too many failures.
- PinChangeError.PinNotEnrolled - Interface in ch.nevis.mobile.sdk.api.operation.pin
-
The specified user in
PinChange.username(String)
does not have an enrolled PIN. - PinChangeError.UserCanceled - Interface in ch.nevis.mobile.sdk.api.operation.pin
-
The PIN change was canceled.
- PinChangeHandler - Interface in ch.nevis.mobile.sdk.api.operation.pin
-
The object handling the old and new PIN provided by the end-user.
- pinChanger(PinChanger) - Method in interface ch.nevis.mobile.sdk.api.operation.pin.PinChange
-
Specifies the object that will be informed of the potential recoverable errors and is responsible for obtaining the PIN from the end-user.
- PinChanger - Interface in ch.nevis.mobile.sdk.api.operation.pin
-
The object in charge of PIN enrollment.
- PinChangeRecoverableError - Interface in ch.nevis.mobile.sdk.api.operation.pin
-
The recoverable error that can occur when changing a PIN.
- PinChangeRecoverableError.CustomValidationError - Interface in ch.nevis.mobile.sdk.api.operation.pin
-
The provided PIN has failed the validation done in
PinPolicy.validatePinForPinChange(char[], Runnable, Consumer)
. - PinChangeRecoverableError.CustomValidationError.Builder - Interface in ch.nevis.mobile.sdk.api.operation.pin
-
A builder for
CustomValidationError
. - PinChangeRecoverableError.InvalidPin - Interface in ch.nevis.mobile.sdk.api.operation.pin
-
The provided old PIN is not valid.
- PinChangeRecoverableError.InvalidPinFormat - Interface in ch.nevis.mobile.sdk.api.operation.pin
-
The provided PIN has characters that are not digits, or its length is not compliant with the minimum and maximum PIN lengths defined in
PinPolicy
. - PinChangeRecoverableError.OldPinEqualsNewPin - Interface in ch.nevis.mobile.sdk.api.operation.pin
-
The old and new PINs are equal.
- pinEnroller(PinEnroller) - Method in interface ch.nevis.mobile.sdk.api.operation.authcloudapi.AuthCloudApiRegistration
-
Specifies the object that will take care of enrolling the PIN of the authenticator.
- pinEnroller(PinEnroller) - Method in interface ch.nevis.mobile.sdk.api.operation.outofband.OutOfBandRegistration
-
Specifies the object that will take care of enrolling the PIN of the authenticator.
- pinEnroller(PinEnroller) - Method in interface ch.nevis.mobile.sdk.api.operation.Registration
-
Specifies the object that will take care of enrolling the PIN of the authenticator.
- PinEnroller - Interface in ch.nevis.mobile.sdk.api.operation.pin
-
The object in charge of PIN enrollment.
- PinEnrollmentContext - Interface in ch.nevis.mobile.sdk.api.operation.pin
-
The object providing some contextual information during PIN enrollment.
- PinEnrollmentError - Interface in ch.nevis.mobile.sdk.api.operation.pin
-
The object that informs that an error occurred during PIN enrollment.
- PinEnrollmentError.CustomValidationError - Interface in ch.nevis.mobile.sdk.api.operation.pin
-
The provided PIN has failed the validation done in
PinPolicy.validatePinForEnrollment(char[], java.lang.Runnable, ch.nevis.mobile.sdk.api.util.Consumer<ch.nevis.mobile.sdk.api.operation.pin.PinEnrollmentError.CustomValidationError>)
. - PinEnrollmentError.CustomValidationError.Builder - Interface in ch.nevis.mobile.sdk.api.operation.pin
-
A builder for
CustomValidationError
. - PinEnrollmentError.InvalidPinFormat - Interface in ch.nevis.mobile.sdk.api.operation.pin
-
The provided PIN has characters that are not digits, or its length is not compliant with the minimum and maximum PIN lengths defined in
PinPolicy
. - PinEnrollmentHandler - Interface in ch.nevis.mobile.sdk.api.operation.pin
-
The object handling the PIN to be enrolled.
- pinPolicy() - Method in interface ch.nevis.mobile.sdk.api.operation.pin.PinChanger
-
Returns the object defining the minimum and maximum length of the new PIN value.
- pinPolicy() - Method in interface ch.nevis.mobile.sdk.api.operation.pin.PinEnroller
-
Returns the object defining the constraints of the PIN to be enrolled.
- pinPolicy() - Method in interface ch.nevis.mobile.sdk.api.operation.pin.PinPolicyProvider
-
Returns the object defining the minimum and maximum length of the PIN.
- PinPolicy - Interface in ch.nevis.mobile.sdk.api.operation.pin
-
The object defining the minimum and maximum length of the PIN.
- PinPolicy.Builder - Interface in ch.nevis.mobile.sdk.api.operation.pin
-
An object that can be used to build a
PinPolicy
that checks for the minimum and maximum PIN length. - PinPolicyProvider - Interface in ch.nevis.mobile.sdk.api.operation.pin
-
An object defining the
PinPolicy
- pins(char[], char[]) - Method in interface ch.nevis.mobile.sdk.api.operation.pin.PinChangeHandler
-
Specify the old PIN and the new PIN.
- PinUserVerificationContext - Interface in ch.nevis.mobile.sdk.api.operation.userverification
-
The object providing information about the PIN user verification (i.e.
- PinUserVerificationError - Interface in ch.nevis.mobile.sdk.api.operation.userverification
-
The recoverable error that can occur when verifying the user with a PIN.
- PinUserVerificationError.InvalidPin - Interface in ch.nevis.mobile.sdk.api.operation.userverification
-
The error that occurs when the user provides a bad PIN.
- PinUserVerificationHandler - Interface in ch.nevis.mobile.sdk.api.operation.userverification
-
The object handling the outcome of an interaction where the user provides PIN credentials.
- pinUserVerifier(PinUserVerifier) - Method in interface ch.nevis.mobile.sdk.api.operation.Authentication
-
Specifies the object that will take care of the PIN user verification.
- pinUserVerifier(PinUserVerifier) - Method in interface ch.nevis.mobile.sdk.api.operation.outofband.OutOfBandAuthentication
-
Specifies the object that will take care of the PIN user verification.
- PinUserVerifier - Interface in ch.nevis.mobile.sdk.api.operation.userverification
-
The object in charge of interacting with the user to do PIN authentication.
- PROTOCOL_ERROR - Enum constant in enum class ch.nevis.mobile.sdk.api.operation.FidoErrorCode
-
A violation of the UAF protocol occurred.
- PUSH_NOTIFICATION - Enum constant in enum class ch.nevis.mobile.sdk.api.operation.outofband.DispatchChannel
-
The Firebase Cloud Messaging (that is, a push notification) was used for the out-of-band operation.
Q
- QR_CODE - Enum constant in enum class ch.nevis.mobile.sdk.api.operation.outofband.DispatchChannel
-
A QR code was used for the out-of-band operation.
R
- RecoverableError - Interface in ch.nevis.mobile.sdk.api.operation
-
The interface implemented by all recoverable errors.
- redeemData() - Method in interface ch.nevis.mobile.sdk.api.operation.outofband.OutOfBandPayload
-
The object containing the redemption information.
- RedeemData - Interface in ch.nevis.mobile.sdk.api.operation.outofband
-
The data with the information required to redeem the token.
- redeemUrl() - Method in interface ch.nevis.mobile.sdk.api.operation.outofband.RedeemData
-
The URL where the token must be redeemed.
- registeredAccounts() - Method in interface ch.nevis.mobile.sdk.api.localdata.RegistrationInfo
-
Returns the objects representing the accounts that are registered with this authenticator.
- registration() - Method in interface ch.nevis.mobile.sdk.api.localdata.Authenticator
-
Returns the object containing the registration information of this
Authenticator
- registration() - Method in interface ch.nevis.mobile.sdk.api.operation.Operations
-
Returns a
Registration
object. - Registration - Interface in ch.nevis.mobile.sdk.api.operation
-
The object that can be used to trigger a registration operation.
- RegistrationInfo - Interface in ch.nevis.mobile.sdk.api.localdata
-
The object exposing the registration information for an
Authenticator
. - registrationRequestPath() - Method in interface ch.nevis.mobile.sdk.api.Configuration
-
The registration request URL path used to send the FIDO UAF registration GetUafRequest.
- registrationRequestPath(String) - Method in interface ch.nevis.mobile.sdk.api.Configuration.Builder
-
Sets the registration request URL path.
- registrationResponsePath() - Method in interface ch.nevis.mobile.sdk.api.Configuration
-
The registration response URL path used to send the final FIDO UAF registration response.
- registrationResponsePath(String) - Method in interface ch.nevis.mobile.sdk.api.Configuration.Builder
-
Sets the registration response path URL.
- remainingRetries() - Method in interface ch.nevis.mobile.sdk.api.operation.password.PasswordAuthenticatorProtectionStatus.LastAttemptFailed
-
The number of remaining retries available.
- remainingRetries() - Method in interface ch.nevis.mobile.sdk.api.operation.pin.PinAuthenticatorProtectionStatus.LastAttemptFailed
-
The number of remaining retries available.
- requestHeaders(RequestHeaders) - Method in interface ch.nevis.mobile.sdk.api.operation.HttpOperation
-
Specifies the additional request headers that must be included in the HTTP requests sent by the operation.
- RequestHeaders - Interface in ch.nevis.mobile.sdk.api.operation
-
The interface defining the HTTP headers that can be provided to
HttpOperation
. - resumeListening() - Method in interface ch.nevis.mobile.sdk.api.operation.userverification.OsAuthenticationListenHandler
-
Resumes listening for OS credentials.
- retryPolicy(RetryPolicy) - Method in interface ch.nevis.mobile.sdk.api.operation.DeviceInformationChange
-
Specifies the retry policy to be used.
- RetryPolicy - Interface in ch.nevis.mobile.sdk.api.operation
-
Some of the operations of the SDK allow to retry the operation (or part of the operation).
- RetryPolicy.Constant - Interface in ch.nevis.mobile.sdk.api.operation
-
The operation will be retried periodically with a maximum number of tries.
- RetryPolicy.Constant.Builder - Interface in ch.nevis.mobile.sdk.api.operation
-
A builder to create a
RetryPolicy.Constant
- RetryPolicy.Exponential - Interface in ch.nevis.mobile.sdk.api.operation
-
The operation will be retried at exponential intervals.
- RetryPolicy.Exponential.Builder - Interface in ch.nevis.mobile.sdk.api.operation
-
A builder to create a
RetryPolicy.Exponential
- RetryPolicy.NoRetry - Interface in ch.nevis.mobile.sdk.api.operation
-
Do not retry: in case of failure the operation will report the error without retrying.
- retryPolicyObtainingAuthorizationProvider(RetryPolicy) - Method in interface ch.nevis.mobile.sdk.api.operation.Authentication
-
The retry policy to be used to obtain an
AuthorizationProvider
after the user authenticates successfully.
S
- selectAccount(AccountSelectionContext, AccountSelectionHandler) - Method in interface ch.nevis.mobile.sdk.api.operation.selection.AccountSelector
-
The account selection interaction.
- selectAuthenticator(AuthenticatorSelectionContext, AuthenticatorSelectionHandler) - Method in interface ch.nevis.mobile.sdk.api.operation.selection.AuthenticatorSelector
-
The authenticator selection interaction.
- server() - Method in interface ch.nevis.mobile.sdk.api.localdata.Account
-
The object describing the server where the account is defined.
- server() - Method in interface ch.nevis.mobile.sdk.api.operation.DeviceInformationCheckError.ClockSkewTooBig
-
The server where the error occurred.
- server() - Method in interface ch.nevis.mobile.sdk.api.operation.DeviceInformationCheckError.Forbidden
-
The server where the error occurred.
- server() - Method in interface ch.nevis.mobile.sdk.api.operation.DeviceInformationCheckError.NetworkError
-
The server where the error occurred.
- server() - Method in interface ch.nevis.mobile.sdk.api.operation.DeviceInformationCheckError.OperationNotSupportedByBackend
-
The server where the error occurred.
- server() - Method in interface ch.nevis.mobile.sdk.api.operation.DeviceInformationMismatch.DeviceNameMismatch
-
The server where the mismatch occurs.
- server() - Method in interface ch.nevis.mobile.sdk.api.operation.DeviceInformationMismatch.FcmRegistrationTokenMismatch
-
The server where the mismatch occurs.
- server() - Method in interface ch.nevis.mobile.sdk.api.operation.DeviceInformationMismatch.MissingAuthenticatorInMobileDevice
-
The server where the mismatch occurs.
- server() - Method in interface ch.nevis.mobile.sdk.api.operation.DeviceInformationMismatch.MissingDeviceInformationInMobileDevice
-
The server where the mismatch occurs.
- server() - Method in interface ch.nevis.mobile.sdk.api.operation.DeviceInformationMismatch.MissingDeviceInformationInServer
-
The server where the mismatch occurs.
- server() - Method in interface ch.nevis.mobile.sdk.api.operation.DeviceInformationSyncError.ClockSkewTooBig
-
The server where the error occurred.
- server() - Method in interface ch.nevis.mobile.sdk.api.operation.DeviceInformationSyncError.NetworkError
-
The server where the error occurred.
- server() - Method in interface ch.nevis.mobile.sdk.api.operation.DeviceInformationSyncError.OperationNotSupportedByBackend
-
The server where the error occurred.
- server() - Method in interface ch.nevis.mobile.sdk.api.operation.outofband.PendingOutOfBandOperationsError.ClockSkewTooBig
-
The server where the error occurred.
- server() - Method in interface ch.nevis.mobile.sdk.api.operation.outofband.PendingOutOfBandOperationsError.NetworkError
-
The server where the error occurred.
- server() - Method in interface ch.nevis.mobile.sdk.api.operation.outofband.PendingOutOfBandOperationsError.OperationNotSupportedByBackend
-
The server where the error occurred.
- Server - Interface in ch.nevis.mobile.sdk.api.localdata
-
The object defining a server.
- serverUrl(URI) - Method in interface ch.nevis.mobile.sdk.api.operation.Registration
-
Specifies the base URL of the server where the registration should be made.
- sessionProvider() - Method in interface ch.nevis.mobile.sdk.api.operation.AuthenticationError
-
Returns the
SessionProvider
that can be used to continue with the operation. - sessionProvider(SessionProvider) - Method in interface ch.nevis.mobile.sdk.api.operation.Authentication
-
Specifies the session provider that must be used to authenticate.
- SessionProvider - Interface in ch.nevis.mobile.sdk.api.authorization
-
Provides the elements required to run an operation in a session.
- SessionProvider.CookieSessionProvider - Interface in ch.nevis.mobile.sdk.api.authorization
-
An HTTP cookie based session provider.
- SessionProvider.EmptySessionProvider - Interface in ch.nevis.mobile.sdk.api.authorization
-
An
SessionProvider
providing no session information. - SessionProvider.JwtSessionProvider - Interface in ch.nevis.mobile.sdk.api.authorization
-
An JWT based session provider.
- signingCertificateSha256(PackageInfo) - Static method in interface ch.nevis.mobile.sdk.api.metadata.MetaData
-
Gives back the SHA-256 hash of the signing certificate of the application that includes the Nevis Mobile Authentication SDK.
T
- title() - Method in interface ch.nevis.mobile.sdk.api.operation.userverification.BiometricPromptOptions
-
The title to be used to prompt the user.
- title() - Method in interface ch.nevis.mobile.sdk.api.operation.userverification.DevicePasscodePromptOptions
-
The title to be used to prompt the user.
- title(String) - Method in interface ch.nevis.mobile.sdk.api.operation.userverification.BiometricPromptOptions.Builder
-
Sets the prompt title.
- title(String) - Method in interface ch.nevis.mobile.sdk.api.operation.userverification.DevicePasscodePromptOptions.Builder
-
Sets the prompt title.
- token() - Method in interface ch.nevis.mobile.sdk.api.operation.outofband.RedeemData
-
The token that must be redeemed in the backend.
- toMimeType() - Method in enum class ch.nevis.mobile.sdk.api.operation.outofband.ContentType
-
The MIME type associated with this content type.
- toString() - Method in interface ch.nevis.mobile.sdk.api.authorization.Cookie
-
The
String
representation of the cookie as described in section 4.1.1 of the RFC 6265. - toString() - Method in interface ch.nevis.mobile.sdk.api.authorization.Jwt
-
The
String
representation of this JWT (i.e. - toString() - Method in enum class ch.nevis.mobile.sdk.api.operation.outofband.ContentType
- transactionConfirmationData() - Method in interface ch.nevis.mobile.sdk.api.operation.selection.AccountSelectionContext
-
The transaction confirmation data, if any, to be presented to the user for verification.
- transactionConfirmationData() - Method in interface ch.nevis.mobile.sdk.api.operation.selection.AuthenticatorSelectionContext
-
The transaction confirmation data, if any, to be presented to the user for verification.
U
- UNKNOWN - Enum constant in enum class ch.nevis.mobile.sdk.api.operation.FidoErrorCode
-
An error condition not described by the above-listed codes.
- UNSUPPORTED_VERSION - Enum constant in enum class ch.nevis.mobile.sdk.api.operation.FidoErrorCode
-
The UAFMessage does not specify a protocol version supported by this FIDO UAF Client.
- UNTRUSTED_FACET_ID - Enum constant in enum class ch.nevis.mobile.sdk.api.operation.FidoErrorCode
-
The client declined to process the operation because the caller's calculated facet identifier was not found in the trusted list for the application identifier specified in the request message.
- url() - Method in interface ch.nevis.mobile.sdk.api.authorization.Cookie
-
The URL of the cookie.
- USER_CANCELED - Enum constant in enum class ch.nevis.mobile.sdk.api.operation.FidoErrorCode
-
The user declined any necessary part of the interaction to complete the registration.
- USER_LOCKOUT - Enum constant in enum class ch.nevis.mobile.sdk.api.operation.FidoErrorCode
-
The operation failed because the user is locked out and the authenticator cannot automatically trigger an action to change that.
- USER_NOT_ENROLLED - Enum constant in enum class ch.nevis.mobile.sdk.api.operation.FidoErrorCode
-
The operation failed because the user is not enrolled to the authenticator and the authenticator cannot automatically trigger user enrollment.
- USER_NOT_RESPONSIVE - Enum constant in enum class ch.nevis.mobile.sdk.api.operation.FidoErrorCode
-
The user took too long to follow an instruction, e.g.
- userEnrollment() - Method in interface ch.nevis.mobile.sdk.api.localdata.Authenticator
-
Returns the user enrollment information.
- UserEnrollment - Interface in ch.nevis.mobile.sdk.api.localdata
-
The object containing the user enrollment information.
- UserEnrollment.OsUserEnrollment - Interface in ch.nevis.mobile.sdk.api.localdata
-
The object containing the user enrollment information for an authenticator whose credentials are managed by the operating system (like the fingerprint authenticator).
- UserEnrollment.SdkUserEnrollment - Interface in ch.nevis.mobile.sdk.api.localdata
-
The object containing the user enrollment information for an authenticator whose credentials are managed by the SDK (like the PIN authenticator).
- userInteractionTimeoutInSeconds() - Method in interface ch.nevis.mobile.sdk.api.Configuration
-
The user interaction timeout in seconds.
- userInteractionTimeoutInSeconds(long) - Method in interface ch.nevis.mobile.sdk.api.Configuration.AuthCloudBuilder
-
Sets the maximum time that the SDK will wait during user interaction to receive the user input.
- userInteractionTimeoutInSeconds(long) - Method in interface ch.nevis.mobile.sdk.api.Configuration.Builder
-
Sets the maximum time that the SDK will wait during user interaction to receive the user input.
- username() - Method in interface ch.nevis.mobile.sdk.api.localdata.Account
-
The username associated with the
Account
. - username() - Method in interface ch.nevis.mobile.sdk.api.localdata.DeviceInformation.IdUsernamePair
-
The username of the account.
- username() - Method in interface ch.nevis.mobile.sdk.api.operation.password.PasswordChangeContext
-
The username whose password must be changed.
- username() - Method in interface ch.nevis.mobile.sdk.api.operation.password.PasswordEnrollmentContext
-
The username associated with the authenticator.
- username() - Method in interface ch.nevis.mobile.sdk.api.operation.pin.PinChangeContext
-
The username whose PIN must be changed.
- username() - Method in interface ch.nevis.mobile.sdk.api.operation.pin.PinEnrollmentContext
-
The username associated with the authenticator.
- username(String) - Method in interface ch.nevis.mobile.sdk.api.operation.Authentication
-
Specifies the username that must be used to authenticate.
- username(String) - Method in interface ch.nevis.mobile.sdk.api.operation.Deregistration
-
Specifies the username whose authenticator must be deregistered.
- username(String) - Method in interface ch.nevis.mobile.sdk.api.operation.password.PasswordChange
-
The username whose password must be changed.
- username(String) - Method in interface ch.nevis.mobile.sdk.api.operation.pin.PinChange
-
The username whose PIN must be changed.
- username(String) - Method in interface ch.nevis.mobile.sdk.api.operation.Registration
-
Specifies the username that must be used to register.
- username(String) - Method in interface ch.nevis.mobile.sdk.api.operation.selection.AccountSelectionHandler
-
Provides the username of the account selected by the user.
- UserVerificationContext - Interface in ch.nevis.mobile.sdk.api.operation.userverification
-
The interface that other user verification context objects inherit from.
V
- validatePasswordForEnrollment(char[], Runnable, Consumer<PasswordEnrollmentError>) - Method in interface ch.nevis.mobile.sdk.api.operation.password.PasswordPolicy
-
Performs validation of the password for enrollment during a registration.
- validatePasswordForPasswordChange(char[], Runnable, Consumer<PasswordChangeRecoverableError.CustomValidationError>) - Method in interface ch.nevis.mobile.sdk.api.operation.password.PasswordPolicy
-
Performs validation of the password during a
PasswordChange
operation. - validatePinForEnrollment(char[], Runnable, Consumer<PinEnrollmentError.CustomValidationError>) - Method in interface ch.nevis.mobile.sdk.api.operation.pin.PinPolicy
-
Performs validation other than the minimum and maximum PIN length during PIN enrollment.
- validatePinForPinChange(char[], Runnable, Consumer<PinChangeRecoverableError.CustomValidationError>) - Method in interface ch.nevis.mobile.sdk.api.operation.pin.PinPolicy
-
Performs validation other than the minimum and maximum PIN length during PIN change.
- valueOf(String) - Static method in enum class ch.nevis.mobile.sdk.api.operation.FidoErrorCode
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class ch.nevis.mobile.sdk.api.operation.outofband.ContentType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class ch.nevis.mobile.sdk.api.operation.outofband.DispatchChannel
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class ch.nevis.mobile.sdk.api.operation.FidoErrorCode
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class ch.nevis.mobile.sdk.api.operation.outofband.ContentType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class ch.nevis.mobile.sdk.api.operation.outofband.DispatchChannel
-
Returns an array containing the constants of this enum class, in the order they are declared.
- verifyBiometric(BiometricUserVerificationContext, BiometricUserVerificationHandler) - Method in interface ch.nevis.mobile.sdk.api.operation.userverification.BiometricUserVerifier
-
The user verification interaction.
- verifyDevicePasscode(DevicePasscodeUserVerificationContext, DevicePasscodeUserVerificationHandler) - Method in interface ch.nevis.mobile.sdk.api.operation.userverification.DevicePasscodeUserVerifier
-
The user verification interaction.
- verifyFingerprint(FingerprintUserVerificationContext, FingerprintUserVerificationHandler) - Method in interface ch.nevis.mobile.sdk.api.operation.userverification.FingerprintUserVerifier
-
The user verification interaction.
- verifyPassword(char[]) - Method in interface ch.nevis.mobile.sdk.api.operation.userverification.PasswordUserVerificationHandler
-
The method to be invoked when the password authenticator must be used.
- verifyPassword(PasswordUserVerificationContext, PasswordUserVerificationHandler) - Method in interface ch.nevis.mobile.sdk.api.operation.userverification.PasswordUserVerifier
-
The user verification interaction called during authentication.
- verifyPin(char[]) - Method in interface ch.nevis.mobile.sdk.api.operation.userverification.PinUserVerificationHandler
-
The method to be invoked when the PIN authenticator must be used.
- verifyPin(PinUserVerificationContext, PinUserVerificationHandler) - Method in interface ch.nevis.mobile.sdk.api.operation.userverification.PinUserVerifier
-
The user verification interaction called during authentication.
- version() - Method in interface ch.nevis.mobile.sdk.api.operation.outofband.OutOfBandPayload
-
The version of the NMA (Nevis Mobile Authentication) data.
- Version - Interface in ch.nevis.mobile.sdk.api.metadata
-
An interface that represents a generic version with
major
,minor
,patch
andbuildNumber
fields.
W
- WAIT_USER_ACTION - Enum constant in enum class ch.nevis.mobile.sdk.api.operation.FidoErrorCode
-
Waiting on user action to proceed.
All Classes and Interfaces|All Packages|Constant Field Values
MobileAuthenticationClientInitializer.context(Context)
instead.