AuthCloudApiError

public enum AuthCloudApiError : MobileAuthenticationClientError
extension AuthCloudApiError: LocalizedError

The error that can occur during AuthCloudApiRegistration operation.

  • A problem with the provided Auth Cloud API response occurred. The message was malformed.

    Declaration

    Swift

    case MalformedPayload(message: String? = nil, cause: Error? = nil)

    Parameters

    message

    Additional information about the error.
    cause

    cause: The underlying error that is related to the error occurred.

  • The encrypted contents of the Auth Cloud API response could not be decrypted. This occurs for instance when the keys that are used to decrypt the Auth Cloud API response are deleted.

    Declaration

    Swift

    case DecryptionError(cause: Error? = nil)

    Parameters

    cause

    The underlying error that is related to the error occurred.

  • The token was already redeemed. This can occur for instance when a user scans twice the same QR code containing a token (a token can only be used once).

    Declaration

    Swift

    case TokenAlreadyRedeemed(cause: Error? = nil)

    Parameters

    cause

    The underlying error that is related to the error occurred.

  • The token has expired. This occurs for example when it took to long to the user to scan a QR code or to open a push notification.

    Declaration

    Swift

    case TokenExpired(cause: Error? = nil)

    Parameters

    cause

    The underlying error that is related to the error occurred.

  • An error that occurs during registration. When try to register a new authenticator in a server for a given username, but there is another authenticator already registered in another server for the same username.

    Important

    A username can only be defined in one server.

    Declaration

    Swift

    case UserAlreadyRegisteredInAnotherServer(message: String, cause: Error? = nil)

    Parameters

    message

    Additional information about the error.
    cause

    The underlying error that is related to the error occurred.

  • A network error occurred while redeeming the token: either the server was not reachable or it returned an HTTP error.

    Declaration

    Swift

    case NetworkError(cause: Error? = nil)

    Parameters

    cause

    The underlying error that is related to the error occurred.

  • A FIDO UAF error occurred.

    Declaration

    Swift

    case FidoError(errorCode: FidoErrorCode, cause: Error? = nil)

    Parameters

    errorCode

    The FIDO error code.
    cause

    The underlying error that is related to the error occurred.

  • Unknown error, handling not categorized error cases.

    Requires

    iOS platform

    Declaration

    Swift

    case Unknown(message: String? = nil, cause: Error? = nil)

    Parameters

    message

    Additional information about the error.
    cause

    The underlying error that is related to the error occurred.

Localized descriptions

  • A message describing what error occurred.

    Declaration

    Swift

    public var errorDescription: String? { get }