VaultMobileSDK  18R3
iOS framework for Vault API
Enumerations | Variables
VEVError.h File Reference

Go to the source code of this file.

Enumerations

enum  VEVAuthError {
  VEVAuthInvalidLoginCredentialsError = -1, VEVAuthInvalidSessionError = -2, VEVAuthInsufficientAccessError = -3, VEVAuthUserLockedOutError = -4,
  VEVAuthUserCanceledLogin = -5, VEVAuthInvalidSecurityProfileError = -6, VEVAuthInvalidAuthenticationServerConfigurationError = -7, VEVAuthAccessDenied = -8,
  VEVAuthServerError = -9, VEVAuthServerTemporarilyUnavailable = -10, VEVAuthStateMismatchError = -11, VEVAuthHTTPError = -12,
  VEVAuthSafariOpenError = -13, VEVAuthJSONDeserializationError = -14, VEVAuthJSONSerializationError = -15, VEVAuthTokenParsingError = -16,
  VEVAuthTokenRefreshError = -17, VEVAuthInvalidClientConfiguration = -18, VEVAuthUnknownOAuthError = -19, VEVAuthUserNotLocallyAuthenticatedError = -20,
  VEVAuthRemoteAuthenticationRequiredError = -21
}
 Error codes that may result during authorization. More...
 
enum  VEVVaultError
 General error codes related to various Vault error conditions. More...
 
enum  VEVaultExceptionError
 Error codes used if a Vault exception occurs.
 
enum  VEVCryptError {
  VEVCryptUnspecifiedError = -1, VEVCryptUserLoggedOutError = -2, VEVCryptEncryptionError = -3, VEVCryptDecryptionError = -4,
  VEVCryptFileIOError = -5
}
 Error codes that may result during encryption or decryption. More...
 
enum  VEVCacheError { VEVCacheUnknownError = -1, VEVCacheUnableToOpenCacheError = -2, VEVCacheUserLoggedOutError = -3, VEVCacheRequestExceptionError = -4 }
 Error codes that may result during cache operations. More...
 
enum  VEVNetworkError
 Error codes used if a network error occurs.
 

Variables

NSString *const VEVAuthorizationErrorDomain
 The error domain for NSErrors that may result during authorization.
 
NSString *const VEVVaultErrorDomain
 The error domain for NSErrors resulting from Vault error conditions. More...
 
NSString *const VEVVaultExceptionErrorDomain
 Error domain for NSErrors resulting from a Vault exception.
 
NSString *const VEVNetworkErrorDomain
 Error domain for NSErrors resulting from a Network problem.
 
NSString *const VEVAPIErrorDomain
 Error domain for API usage errors.
 
NSString *const VEVCryptographyErrorDomain
 Error domain for encryption errors.
 
NSString *const VEVCacheErrorDomain
 Error domain for Cache errors.
 
NSString *const VEVVaultServerErrorMessageKey
 The error key for the underlying Vault error message.
 
NSString *const VEVVaultRequestedVaultIDKey
 The error key to retreive the Vault ID that resulted in a VEVVaultSelectedVaultUnavailableError.
 
NSString *const VEVInvalidServerResponseKey
 The error key for the underlying server response that resulted in a VEVAuthInvalidSecurityProfileError.
 

Detailed Description

Enumeration Type Documentation

◆ VEVAuthError

Error codes that may result during authorization.

Enumerator
VEVAuthInvalidLoginCredentialsError 

Indicates invalid login credentials.

VEVAuthInvalidSessionError 

Indicates the Vault session is invalid or expired.

VEVAuthInsufficientAccessError 

Indicates insufficient permissions for the current operations.

VEVAuthUserLockedOutError 

Indicates the user is locked out.

VEVAuthUserCanceledLogin 

Indicates the user canceled logging in.

VEVAuthInvalidSecurityProfileError 

Indicates a misconfigured OpenID connect discovery configuration.

VEVAuthInvalidAuthenticationServerConfigurationError 

Indicates an OAuth security profile is configured incorrectly.

VEVAuthAccessDenied 

Indicates user denied granting access to client application.

VEVAuthServerError 

Indicates an error occurred on the authentication server.

VEVAuthServerTemporarilyUnavailable 

Indicates the authentication server is temporarily unavailable.

VEVAuthStateMismatchError 

Indicates a client-side OAuth error occurred (e.g., because of a state mismatch or a misconfigured client, should be treated as uncrecoverable.

VEVAuthHTTPError 

Indicates an HTTP error occurred during authentications.

VEVAuthSafariOpenError 

Indicates an error occurred opening Safari during authorization via OAuth.

VEVAuthJSONDeserializationError 

Indicates an error occurred serializing/deserializing an authentication server response. This error implies a faulty authentication server and should be treated as unrecoverable.

VEVAuthJSONSerializationError 

Indicates an error occurred serializing/deserializing an authentication server response. This error implies a faulty authentication server and should be treated as unrecoverable.

VEVAuthTokenParsingError 

Indicates an error occurred parsing an authorization token or openid token. This error implies a faulty authentication server and should be treated as unrecoverable.

VEVAuthTokenRefreshError 

Indicates an error occurred refreshing access tokens/open id tokens other than an expired refresh token. This error implies a faulty authentication server and should be treated as unrecoverable.

VEVAuthInvalidClientConfiguration 

Indicates client-side values in the applications Info.plist file are misconfigured.

VEVAuthUnknownOAuthError 

Indicates an unknown error occurred during authorization via OAuth.

VEVAuthUserNotLocallyAuthenticatedError 

Indicates the requested operation requires that the user authenticate with Vault.

VEVAuthRemoteAuthenticationRequiredError 

Indicates that the requested operation required a valid Vault session.

◆ VEVVaultError

General error codes related to various Vault error conditions.

See also
TODO VEVVaultServerErrorMessageKey.

◆ VEVCryptError

Error codes that may result during encryption or decryption.

Enumerator
VEVCryptUnspecifiedError 

Indicates an unexpected error.

VEVCryptUserLoggedOutError 

Indicates the user is not locally authenticated.

VEVCryptEncryptionError 

Indicates an error occurred in the encryption process.

VEVCryptDecryptionError 

Indicates an error occurred in the decryption process.

VEVCryptFileIOError 

Indicates an error occurred reading or saving the encrypted file.

◆ VEVCacheError

Error codes that may result during cache operations.

Enumerator
VEVCacheUnknownError 

Indicates an unknown cache error.

VEVCacheUnableToOpenCacheError 

Indicates the cache cannot be opened.

VEVCacheUserLoggedOutError 

Indicates there is no currently logged in user.

VEVCacheRequestExceptionError 

Indicates the requested caching operation failed.

Variable Documentation

◆ VEVVaultErrorDomain

NSString* const VEVVaultErrorDomain

The error domain for NSErrors resulting from Vault error conditions.

See also
https://developer.veevavault.com/api/18.1/#errors