APIError

enum APIError : Error

Complete list of errors that can be generated by the API

  • Default error, means that something unexpected happens.

    Declaration

    Swift

    case unexpectedError

  • Error generates when the token exchange request can’t be obtained from last authorization response.

    Declaration

    Swift

    case failedToObtainTokenExchangeRequestFromLastAuthorizationResponse

  • Error generates when some of the logout components (logout url, auth endpoint, token endpoint, id token) can’t be obtained.

    Declaration

    Swift

    case failedToObtainLogoutComponents

  • Error indicates that OIDExternalUserAgentIOS object can’t be created.

    Declaration

    Swift

    case failedToCreateExternalUserAgent

  • Error generates when URL object can’t be created from passed redirectUri string.

    Declaration

    Swift

    case failedToObtainRedirectUri

  • Error generates when the OIDServiceConfiguration can’t be obtained using AppAuth framework.

    Declaration

    Swift

    case failedToDiscoverConfiguration

  • Generates when the URL object can’t be created from the passed domain string.

    Declaration

    Swift

    case failedToCreateDomainUrlFromConfig

  • Generates when the request url can’t be obtained from OIDAuthorizationRequest object.

    Declaration

    Swift

    case failedToObtainRequestUrl

  • Generates when the hybrid flow request can’t be present because the app is under guided access mode.

    Declaration

    Swift

    case failedToRunAuthSessionAppIsUnderGuidedAccessMode

  • Generates when the OIDAuthorizationSession object can’t be created with the passed OIDAuthorizationRequest.

    Declaration

    Swift

    case failedToCreateAuthorizationSession

  • Generates when the URL object can’t be created with the string after replacing # to ? inside it.

    Declaration

    Swift

    case failedToModifyUrl

  • Generates when the id token string passed inside validation function is invalid.

    Declaration

    Swift

    case failedToUnwrapIdTokenString

  • Generates when the token structure is invalid (the token string doesn’t have two dots, so it can’t be splitted on header, payload and signature).

    Declaration

    Swift

    case wrongTokenStructure

  • Generates when the id token header is wrong and can’t be parsed.

    Declaration

    Swift

    case failedToParseIdTokenHeader

  • Generates when the id token payload is wrong and can’t be parsed.

    Declaration

    Swift

    case failedToParseIdTokenPayload

  • Generates when the id token header key id property isn’t equal to the key id property obtained from jwksUrl

    Declaration

    Swift

    case keyIdsAreDifferentError

  • Generates when the id token payload is invalid.

    Declaration

    Swift

    case failedToValidateIdTokenPayload

  • Generates when the public key can’t be created from the modulus and exponent obtained via jwls url.

    Declaration

    Swift

    case failedToCreatePublicKey

  • Generates when the authorization code is invalid, based on validation via cHash property stored in payload.

    Declaration

    Swift

    case failedToValidateAuthCode

  • Generates when the data from jwks url can’t be obtained.

    Declaration

    Swift

    case failedToObtainDataFromJwksUrl

  • Generates when the json object can’t be created with the data obtained from jwks url.

    Declaration

    Swift

    case failedToCreateJsonFromJwksUrlData

  • Generates when there is no object with proper key id and algorithm properties among objects obtained from jwks url data.

    Declaration

    Swift

    case failedToFindObjectWithProperKeyId

  • Generates when the json configuration of the obtained from jwks url dictionary is unexpected.

    Declaration

    Swift

    case unexpectedJsonConfiguration

  • Generates when the dictionary is invalid and can’t be unwrapped.

    Declaration

    Swift

    case failedToUnwrapDictionary

  • Generates when the authorization response is invalid and can’t be unwrapped.

    Declaration

    Swift

    case failedToUnwrapAuthResponse

  • Generates when the jwks url is invalid and can’t be unwrapped.

    Declaration

    Swift

    case failedToUnwrapJwksUrl

  • Generates when the biometricManager object is invalid, it means that its creation failed.

    Declaration

    Swift

    case biometricManagerCreationFailure

  • Generates when the user specifies biometric usage on device that doesn’t support such authentication.

    Declaration

    Swift

    case biometricIsNotSupportedError

  • Generates when the biometric authentication error is occured.

    Declaration

    Swift

    case biometricAuthenticationError