Enumerations

The following enumerations are available globally.

  • Results of AppIntegrity Failures We need to return some of failures for iOS12, iOS13 devices as well.

    See more

    Declaration

    Swift

    public enum FRDeviceCheckAPIFailure : String, Error

  • List of clientErrors sent to AM

    See more

    Declaration

    Swift

    public enum FRAppIntegrityClientError : String

  • AdviceType of AM’s policy engine; currently only supports: TransactionConditionAdvice | AuthenticateToServiceConditionAdvice

    See more

    Declaration

    Swift

    public enum AdviceType : String

Callback enums

  • Option Type for Callback

    • unspecifiedOption: unpsecifiedOption; -1
    • yesNoOption: YES/NO option; 0
    • yesNoCancelOption: YES/NO/CANCEL option; 1
    • okCancelOption: OK/CANCEL option; 2
    • unknown: default when value is not provided
    See more

    Declaration

    Swift

    @objc(FRCallbackOptionType)
public enum OptionType : Int

  • Option for Callback

    • yes: YES; 0
    • no: NO; 1
    • cancel: CANCEL; 2
    • ok: OK; 3
    • unknown: default when value is not provided
    See more

    Declaration

    Swift

    @objc(FRCallbackOption)
public enum Option : Int

  • Message Type for Callback

    • information: INFORMATION; 0

    Warning

    WARNING; 1
    • error: ERROR; 2
    • unknown: default when value is not provided
    See more

    Declaration

    Swift

    @objc(FRCallbackMessageType)
public enum MessageType : Int

Public WebAuthn enumerations

  • User consent result for WebAuthn registration/authentication operation

    See more

    Declaration

    Swift

    public enum WebAuthnUserConsentResult

  • WebAuthn Attestation Conveyance Preference Option enumeration

    See more

    Declaration

    Swift

    public enum WAAttestationPreference : String

  • WebAuthn User Verification enumeration

    See more

    Declaration

    Swift

    public enum WAUserVerification : String

  • WebAuthn Authenticator Attachment option enumeration

    See more

    Declaration

    Swift

    public enum WAAuthenticatorAttachment : String
  • See more

    Declaration

    Swift

    public enum AuthApiError : FRError
    extension AuthApiError: CustomNSError

  • AuthError represents an error captured by FRAuth SDK during authentication

    • invalidTokenResponse: Invalid response from OAuth2 protocol for exchanging SSO Token with OAuth2 token set; token response must contain at least followings: access_token, scope, token_type, expires_in
    • invalidCallbackResponse: Invalid AuthService response for parsing Callback(s)
    • unsupportedCallback: Invalid AuthService response containing unsupported Callback type(s)
    • invalidAuthServiceResponse: Invalid AuthService response for missing/invalid authId
    • invalidOAuth2Client: Invalid AuthService or Node object without OAuth2Client while expecting to process OAuth2 protocol
    • invalidGenericType: Invalid generic type
    • userAlreadyAuthenticated: An error when there is already authenticated session (Session Token and/or OAuth2 token set)
    • authenticationCancelled: An error when the authentication process is cancelled
    See more

    Declaration

    Swift

    public enum AuthError : FRError
    extension AuthError: CustomNSError

  • BrowserError represents an error captured by FRAuth SDK for Browser (external user-agent) related operation

    See more

    Declaration

    Swift

    public enum BrowserError : FRError
    extension BrowserError: CustomNSError

  • ConfigError represents an error captured by FRAuth SDK for missing or invalid configuration

    • emptyConfiguration: Empty configuration is provided for initialization
    • invalidConfiguration: Missing or invalid configuration is provided
    • invalidAccessGroup: Invalid Access Group; given Access Group is not accessible with Keychain Service
    • invalidSDKState: Invalid SDK state; SDK may need to be initialized before performing certain action
    See more

    Declaration

    Swift

    public enum ConfigError : FRError
    extension ConfigError: CustomNSError

  • OAuth2Error represents an error captured by FRAuth SDK for OAuth2 related operation

    See more

    Declaration

    Swift

    public enum OAuth2Error : FRError
    extension OAuth2Error: CustomNSError
  • See more

    Declaration

    Swift

    public enum SocialLoginError : FRError
    extension SocialLoginError: CustomNSError

  • ConfigError represents an error captured by FRAuth SDK for invalid operation related to Token with given state

    • failToParseToken: Failed to parse token from secure storage
    • nullRefreshToken: Missing refresh_token while it’s required
    • nullToken: Missing token value while it’s required
    See more

    Declaration

    Swift

    public enum TokenError : FRError
    extension TokenError: CustomNSError

  • WebAuthnError represents an error captured by FRAuth SDK for WebAuthn related operation

    See more

    Declaration

    Swift

    public enum WebAuthnError : Error
    extension WebAuthnError: CustomNSError

  • Enumeration for available auth type through FRAuth

    • authentication: Auth type for authentication or user login
    • registration: Auth type for user registration
    See more

    Declaration

    Swift

    @objc
public enum FRAuthFlowType : Int

  • BrowserType enum is a representation of type of external user-agent supported in Browser object

    See more

    Declaration

    Swift

    @objc
public enum BrowserType : Int