WebAuthError

public struct WebAuthError : Auth0Error
extension WebAuthError: Equatable

Represents an error during a Web Auth operation.

  • The underlying Error value, if any. Defaults to nil.

    Declaration

    Swift

    public let cause: Error?
  • Description of the error.

    Important

    You should avoid displaying the error description to the user, it’s meant for debugging only.

    Declaration

    Swift

    public var debugDescription: String { get }

Error Cases

  • The bundle identifier could not be retrieved from Bundle.main.bundleIdentifier, or it could not be used to build a valid URL. This error does not include a cause.

    Declaration

    Swift

    public static let noBundleIdentifier: WebAuthError
  • The invitation URL is missing the invitation and/or the organization query parameters. This error does not include a cause.

    Declaration

    Swift

    public static let invalidInvitationURL: WebAuthError
  • The user cancelled the Web Auth operation. This error does not include a cause.

    Declaration

    Swift

    public static let userCancelled: WebAuthError
  • The Auth0 application does not support authentication with Proof Key for Code Exchange (PKCE). PKCE support needs to be enabled in the settings page of the Auth0 application, by setting the Application Type to ‘Native’ and the Token Endpoint Authentication Method to ‘None’. This error does not include a cause.

    Declaration

    Swift

    public static let pkceNotAllowed: WebAuthError
  • The callback URL is missing the code query parameter. This error does not include a cause.

    Declaration

    Swift

    public static let noAuthorizationCode: WebAuthError
  • The ID Token validation performed after authentication failed. The underlying Error value can be accessed via the cause property.

    Declaration

    Swift

    public static let idTokenValidationFailed: WebAuthError
  • An unexpected error occurred, and an Error value is available. The underlying Error value can be accessed via the cause property.

    Declaration

    Swift

    public static let other: WebAuthError
  • An unexpected error occurred, but an Error value is not available. This error does not include a cause.

    Declaration

    Swift

    public static let unknown: WebAuthError

Equatable

  • Conformance to Equatable.

    Declaration

    Swift

    public static func == (lhs: WebAuthError, rhs: WebAuthError) -> Bool

Pattern Matching Operator

  • Matches WebAuthError values in a switch statement.

    Declaration

    Swift

    static func ~= (lhs: WebAuthError, rhs: WebAuthError) -> Bool
  • Matches Error values in a switch statement.

    Declaration

    Swift

    static func ~= (lhs: WebAuthError, rhs: Error) -> Bool