User Interaction
-
The object in charge of selecting an account. This protocol must be conformed by the user of the SDK only when username-less out-of-band authentication is required with multiple accounts.
See moreDeclaration
Swift
public protocol AccountSelector
-
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.
See
AccountSelector
Declaration
Swift
public protocol AccountSelectionContext : Encodable
-
The object handling the outcome of an interaction where the user chooses the account to be used.
See
AccountSelector
Declaration
Swift
public protocol AccountSelectionHandler : CancelableHandler
-
The object in charge of selecting the authenticator to be used to perform an operation.
Note
The SDK does not provide implementations of this interface. The implementation must be done by the user of the SDK.
See
See
Declaration
Swift
public protocol AuthenticatorSelector
-
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.
See moreDeclaration
Swift
public protocol AuthenticatorSelectionContext : Encodable
-
The object handling the outcome of an interaction where the user chooses the authenticator to be used.
See moreDeclaration
Swift
public protocol AuthenticatorSelectionHandler : CancelableHandler
-
The object handling the old and new PIN provided by the end-user.
Note
The SDK does not provide implementations of this interface. The implementation must be done by the user of the SDK.
See
Declaration
Swift
public protocol PinChanger : PinPolicyProvider
-
The object providing some contextual information during PIN change.
See moreDeclaration
Swift
public protocol PinChangeContext
-
The object handling the old and new PIN provided by the end-user.
See moreDeclaration
Swift
public protocol PinChangeHandler : CancelableHandler
-
The object in charge of PIN enrollment.
Note
The SDK does not provide implementations of this interface. The implementation must be done by the user of the SDK.
Declaration
Swift
public protocol PinEnroller : PinPolicyProvider
-
Declaration
Swift
public protocol PinEnrollmentContext
-
The object handling the PIN to be enrolled.
See moreDeclaration
Swift
public protocol PinEnrollmentHandler : CancelableHandler
-
The object handling the old and new password provided by the end-user.
Note
The SDK does not provide implementations of this interface. The implementation must be done by the user of the SDK.
Declaration
Swift
public protocol PasswordChanger : PasswordPolicyProvider
-
The object providing some contextual information during password change.
See moreDeclaration
Swift
public protocol PasswordChangeContext
-
The object handling the old and new password provided by the end-user.
See moreDeclaration
Swift
public protocol PasswordChangeHandler : CancelableHandler
-
The object in charge of password enrollment.
Note
The SDK does not provide implementations of this interface. The implementation must be done by the user of the SDK.
Declaration
Swift
public protocol PasswordEnroller : PasswordPolicyProvider
-
The object providing some contextual information during password enrollment.
See
PasswordEnroller
Declaration
Swift
public protocol PasswordEnrollmentContext
-
The object handling the password to be enrolled.
See moreDeclaration
Swift
public protocol PasswordEnrollmentHandler : CancelableHandler
-
The protocol that other user verification context objects conform to.
See moreDeclaration
Swift
public protocol UserVerificationContext : Encodable
-
The object in charge of interacting with the user to do PIN authentication.
Note
The SDK does not provide implementations of this interface. The implementation must be done by the user of the SDK if the PIN authenticator is required.
See
Declaration
Swift
public protocol PinUserVerifier
-
The object providing information about the PIN user verification (i.e. the user credential validation) operation to be done.
This object contains the information required to ask the user to authenticate: the authenticator to be used, whether there were previous errors authenticating, etc.
See moreDeclaration
Swift
public protocol PinUserVerificationContext : UserVerificationContext
-
The object handling the outcome of an interaction where the user provides PIN credentials.
This is used with the
Pin
See
PinUserVerifier
Declaration
Swift
public protocol PinUserVerificationHandler : CancelableHandler
-
The object describing the PIN authenticator protection status. It provides information regarding how many retries are available for the end user before locking the authenticator.
See moreDeclaration
Swift
public enum PinAuthenticatorProtectionStatus : Equatable, Encodable
-
Declaration
Swift
public protocol PinPolicyProvider
-
The object defining the minimum and maximum length of the PIN.
See
PinEnroller
See
PinChanger
Declaration
Swift
public protocol PinPolicy
-
The object in charge of interacting with the user to do password authentication.
Note
The SDK does not provide implementations of this interface. The implementation must be done by the user of the SDK if the password authenticator is required.
See
Declaration
Swift
public protocol PasswordUserVerifier
-
The object providing information about the password user verification (i.e. the user credential validation) operation to be done.
This object contains the information required to ask the user to authenticate: the authenticator to be used, whether there were previous errors authenticating, etc.
See moreDeclaration
Swift
public protocol PasswordUserVerificationContext : UserVerificationContext
-
The object handling the outcome of an interaction where the user provides password credentials.
This is used with the
See morePassword
Declaration
Swift
public protocol PasswordUserVerificationHandler : CancelableHandler
-
The object describing the password authenticator protection status. It provides information regarding how many retries are available for the end user before locking the authenticator.
See moreDeclaration
Swift
public enum PasswordAuthenticatorProtectionStatus : Equatable, Encodable
-
Declaration
Swift
public protocol PasswordPolicyProvider
-
The object defining whether the password provided by a user during enrollment or when changing is valid.
See
PasswordEnroller
See
PasswordChanger
Declaration
Swift
public protocol PasswordPolicy
-
The object in charge of interacting with the user to do biometric authentication.
Note
The SDK does not provide implementations of this interface. The implementation must be done by the user of the SDK if the biometric authenticator is required.
See
See
Declaration
Swift
public protocol BiometricUserVerifier
-
The object providing information about the Biometric user verification (i.e. the user credential validation) operation to be done.
Declaration
Swift
public protocol BiometricUserVerificationContext : UserVerificationContext
-
The object handling the outcome of an interaction where the user provides biometric credentials.
This is used with the
See moreAuthenticatorAaid.Fingerprint
, orAuthenticatorAaid.FaceRecognition
. The particularity of this authenticator with the other authenticators, is that the SDK relies on the operating system prompt to authentication. (i.e. there is no need to develop a GUI to do the authentication when this authenticator is used).Declaration
Swift
public protocol BiometricUserVerificationHandler : CancelableHandler
-
The object in charge of interacting with the user to do authenticate using the device passcode.
Note
The SDK does not provide implementations of this interface. The implementation must be done by the user of the SDK if the device passcode authenticator is required.
See
See
Declaration
Swift
public protocol DevicePasscodeUserVerifier
-
The object providing information about the device passcode user verification (i.e. the user credential validation) operation to be done.
Declaration
Swift
public protocol DevicePasscodeUserVerificationContext : UserVerificationContext
-
The object handling the outcome of an interaction where the user provides device passcode credentials.
This is used with the
See moreAuthenticatorAaid/DevicePasscodes
. The particularity of this authenticator with the other authenticators, is that the SDK relies on the operating system prompt to authentication. (i.e. there is no need to develop a GUI to do the authentication when this authenticator is used).Declaration
Swift
public protocol DevicePasscodeUserVerificationHandler : CancelableHandler
-
The protocol that operation or user interaction handlers are derived from.
See moreDeclaration
Swift
public protocol CancelableHandler