Registration

public protocol Registration : HttpOperation

The object that can be used to trigger a registration operation.

Usage example:

class AuthenticatorSelectorImpl: AuthenticatorSelector {
    func selectAuthenticator(context: AuthenticatorSelectionContext, handler: AuthenticatorSelectionHandler) {
        handler.aaid(aaid)
    }
}

class BiometricUserVerifierImpl: BiometricUserVerifier {
    func verifyBiometric(context: BiometricUserVerificationContext, handler: BiometricUserVerificationHandler) {
        handler.verify()
    }
}

class DevicePasscodeUserVerifierImpl: DevicePasscodeUserVerifier {
    func verifyDevicePasscode(context: DevicePasscodeUserVerificationContext, handler: DevicePasscodeUserVerificationHandler) {
        handler.verify()
    }
}

class PinEnrollerImp: PinEnroller {
    func enrollPin(context: PinEnrollmentContext, handler: PinEnrollmentHandler) {
        handler.pin(pin)
    }
}

client.operations.registration
    .username(username)
    .serverBaseUrl(URL(string: "https://server/path")!)
    .authenticatorSelector(AuthenticatorSelectorImpl(...))
    .biometricUserVerifier(BiometricUserVerifierImpl(...))
    .devicePasscodeUserVerifier(DevicePasscodeUserVerifierImpl(...))
    .pinEnroller(PinEnrollerImp(...))
    .onError { error in
        ...
    }
    .onSuccess {
        ...
    }
    .execute()

The biometric and device Passcode authenticators are enrolled at the OS level. That is why, if one of them must be registered, the user must authenticate through BiometricUserVerifier or DevicePasscodeUserVerifier. In the case of the PIN, the PIN is enrolled during registration, so no verification is needed.

  • Specifies the username that must be used to register.

    Important

    Providing the username is required.

    Declaration

    Swift

    @discardableResult
func username(_ username: String) -> Registration

    Parameters

    username

    the username.

    Return Value

    the Registration builder.

  • Specifies the base URL of the server where the registration should be made.

    Note

    If no server URL is provided, then the base URL defined in `baseUrl will be used.

    Important

    It is assumed that all the servers have the same endpoints, thus only the scheme, hostname and port of the URL of the provided URL will be taken into account.

    • Example #1:

      • baseUrl: https://server/path
      • Provided server URL in Registration/serverUrl(_:): https://other.server
      • Resulting Server URL: https://other.server/path///

    • Example #2:

      • baseUrl: https://server:443/path
      • Provided server URL in Registration/serverUrl(_:): https://other.server/path
      • Resulting Server URL: https://other.server/path

    • Example #3:

      • baseUrl: https://server/path
      • Provided server URL in Registration/serverUrl(_:): http://other.server:80/otherpath
      • Resulting Server URL: http://other.server:80/path

    Declaration

    Swift

    @discardableResult
func serverUrl(_ serverUrl: URL) -> Registration

    Parameters

    serverUrl

    the URL of the server where the registration should be made.

    Return Value

    the Registration builder.

  • Specifies the authorization provider that must be used to register the authenticator.

    Declaration

    Swift

    @discardableResult
func authorizationProvider(_ authorizationProvider: AuthorizationProvider) -> Registration

    Parameters

    authorizationProvider

    Return Value

    the Registration builder.

  • Specifies the device information to be used. The DeviceInformation is required only if there is not a DeviceInformation already defined (that is, if this is the first registration). If a DeviceInformation was already provided in an existing registration, the provided value will be ignored.

    Declaration

    Swift

    @discardableResult
func deviceInformation(_ deviceInformation: DeviceInformation) -> Registration

    Parameters

    deviceInformation

    the device information.

    Return Value

    the Registration builder.

  • Specifies whether the OS device passcode can be used as fallback during biometric authentication. If not specified, the device passcode cannot be used as fallback.

    Declaration

    Swift

    @discardableResult
func allowDevicePasscodeAsFallback(_ allowDevicePasscodeAsFallback: Bool) -> Registration

    Parameters

    allowDevicePasscodeAsFallback

    indicates whether the device passcode can be used as fallback.

    Return Value

    the Registration builder.

  • Specifies whether the authenticator must be invalidated if the user adds new biometric credentials in the OS settings. If the authenticator has been invalidated, and you try to authenticate with it, an error with code FidoErrorCode.keyDisappearedPermanently will be returned by the authentication operation.

    This setting only applies to faceRecognition (AuthenticatorAaid.FaceRecognition) and fingerprint (AuthenticatorAaid.Fingerprint) authenticators. By setting this parameter to true, you increase the security but there is a loss of convenience: adding a new OS biometric credential does not imply necessarily that there is a security risk, but if the end-user does it, a new registration will be required, because an invalidated authenticator cannot be recovered. If not specified, the authenticator will be invalidated when the user adds a new biometric credential in the OS settings.

    Declaration

    Swift

    @discardableResult
func invalidateOnNewOsBiometrics(_ invalidateOnNewOsBiometrics: Bool) -> Registration

    Parameters

    invalidateOnNewOsBiometrics

    indicates whether an addition of biometric credentials in the OS should invalidate this authenticator (if the authenticator is Face ID or Touch ID)

    Return Value

    the Registration builder.

  • Specifies the object that will take care of the selection of the authenticator to be used.

    Important

    Providing the authenticator selector is required.

    Declaration

    Swift

    @discardableResult
func authenticatorSelector(_ authenticatorSelector: AuthenticatorSelector) -> Self

    Parameters

    authenticatorSelector

    Return Value

    the Registration builder.

  • Specifies the object that will take care of the biometric user verification. It must be provided only if a biometric authenticator must be registered.

    Important

    Providing at least one of the BiometricUserVerifier, DevicePasscodeUserVerifier or PinEnroller is required.

    Declaration

    Swift

    @discardableResult
func biometricUserVerifier(_ biometricUserVerifier: BiometricUserVerifier) -> Self

    Parameters

    biometricUserVerifier

    Return Value

    the Registration builder.

  • Specifies the object that will take care of the device passcode user verification.

    Important

    Providing at least one of the BiometricUserVerifier, DevicePasscodeUserVerifier or PinEnroller is required.

    Declaration

    Swift

    @discardableResult
func devicePasscodeUserVerifier(_ devicePasscodeUserVerifier: DevicePasscodeUserVerifier) -> Self

    Parameters

    devicePasscodeUserVerifier

    Return Value

    the Registration builder.

  • Specifies the object that will take care of enrolling the PIN of the authenticator. It must be provided only if a PIN authenticator must be registered.

    Important

    Providing at least one of the BiometricUserVerifier, DevicePasscodeUserVerifier or PinEnroller is required.

    Declaration

    Swift

    @discardableResult
func pinEnroller(_ pinEnroller: PinEnroller) -> Registration

    Parameters

    pinEnroller

    Return Value

    the Registration builder.

  • Specifies the block to execute if the registration was successful. This object will be invoked in the DispatchQueue.main thread.

    Important

    Providing the onSuccess block is required.

    Declaration

    Swift

    @discardableResult
func onSuccess(_ onSuccess: @escaping () -> ()) -> Registration

    Parameters

    onSuccess

    the block to execute on successful registration.

    Return Value

    the Registration builder.

  • Specifies the block to execute if the registration failed. This object will be invoked in the DispatchQueue.main thread.

    Important

    Providing the onError block is required.

    Declaration

    Swift

    @discardableResult
func onError(_ onError: @escaping (OperationError) -> ()) -> Registration

    Parameters

    onError

    the block to execute on failed registration, receives an OperationError.

    Return Value

    the Registration builder.