VaultMobileSDK  18R3
iOS framework for Vault API
VEVError.h
Go to the documentation of this file.
1 
6 #import <Foundation/Foundation.h>
7 
8 
12 FOUNDATION_EXPORT NSString * const VEVAuthorizationErrorDomain;
13 
19 FOUNDATION_EXPORT NSString * const VEVVaultErrorDomain;
20 
23 FOUNDATION_EXPORT NSString * const VEVVaultExceptionErrorDomain;
24 
27 FOUNDATION_EXPORT NSString * const VEVNetworkErrorDomain;
28 
31 FOUNDATION_EXPORT NSString * const VEVAPIErrorDomain;
32 
35 FOUNDATION_EXPORT NSString * const VEVCryptographyErrorDomain;
36 
39 FOUNDATION_EXPORT NSString * const VEVCacheErrorDomain;
40 
41 
44 typedef NS_ENUM(NSInteger, VEVAuthError) {
48 
52 
57 
61 
65 
70 
75 
80 
85 
90 
96 
101 
106 
112 
118 
124 
131 
136 
141 
146 
151 };
152 
157 typedef NS_ENUM(NSInteger, VEVVaultError) {
158  VEVVaultInvalidDataError = -1,
159  VEVVaultOperationNotAllowedError = -2,
160  VEVVaultParameterRequiredError = -3,
161  VEVVaultMaxFileSizeExceededError = -4,
162  VEVVaultDownForMaintenanceError = -5,
163  VEVVaultPasscodeChangeRequiredError = -6,
164  VEVVaultInactiveUserError = -7,
165  VEVVaultNoActiveVaultsError = -8,
166  VEVVaultSoleInactiveVaultError = -9,
167  VEVVaultConfigurationModeEnabledError = -10,
168  VEVVaultIPRangeError = -11,
169  VEVVaultSoleProtectedTemplateVaultError = -12,
170  VEVVaultSelectedVaultUnavailableError = -13, // not a Vault API error response code but signaled by the SDK when a vault auth default logic does not select the actual Vault requested
171  VEVVaultMethodNotSupportedError = -14,
172  VEVVaultInvalidTokenError = -15,
173  VEVVaultExpiredTokenError = -16,
174  VEVVaultInvalidConfigurationError = -17,
175  VEVVaultMalformedURLError = -18,
176  VEVVaultInvalidFilterError = -19,
177  VEVVaultInvalidParameterError = -20,
178  VEVVaultInvalidDocumentError = -21
179 };
180 
183 typedef NS_ENUM(NSInteger, VEVaultExceptionError) {
184  VEVVaultExceptionUnspecifiedError = -1,
185  VEVVaultExceptionServerReturnedInvalidURLError = -2
186 };
187 
191 typedef NS_ENUM(NSInteger, VEVCryptError) {
195 
199 
203 
207 
212 };
213 
217 typedef NS_ENUM(NSInteger, VEVCacheError) {
221 
225 
229 
233 };
234 
237 typedef NS_ENUM(NSInteger, VEVNetworkError) {
238  VEVNoNetworkConnection = -1
239 };
240 
243 typedef NS_ENUM(NSInteger, VEVAPIError) {
244  VEVInvalidParameter = -1
245 };
246 
249 FOUNDATION_EXPORT NSString * const VEVVaultServerErrorMessageKey;
250 
254 FOUNDATION_EXPORT NSString * const VEVVaultRequestedVaultIDKey; // for VEVVaultSelectedVaultUnavailableError, userInfo key to retrieve ID of unavailable vault;
255 
259 FOUNDATION_EXPORT NSString * const VEVInvalidServerResponseKey; // userInfo key to retrieve malformed response
NSString *const VEVVaultExceptionErrorDomain
Error domain for NSErrors resulting from a Vault exception.
Definition: VEVError.h:23
Indicates user denied granting access to client application.
Definition: VEVError.h:79
NSString *const VEVVaultErrorDomain
The error domain for NSErrors resulting from Vault error conditions.
Definition: VEVError.h:19
Indicates an error occurred serializing/deserializing an authentication server response. This error implies a faulty authentication server and should be treated as unrecoverable.
Definition: VEVError.h:117
NSString *const VEVCacheErrorDomain
Error domain for Cache errors.
Definition: VEVError.h:39
Indicates an HTTP error occurred during authentications.
Definition: VEVError.h:100
Indicates an error occurred in the encryption process.
Definition: VEVError.h:202
Indicates an unknown cache error.
Definition: VEVError.h:220
Indicates an error occurred refreshing access tokens/open id tokens other than an expired refresh tok...
Definition: VEVError.h:130
Indicates the requested caching operation failed.
Definition: VEVError.h:232
Indicates an error occurred parsing an authorization token or openid token. This error implies a faul...
Definition: VEVError.h:123
VEVCryptError
Error codes that may result during encryption or decryption.
Definition: VEVError.h:191
Indicates an OAuth security profile is configured incorrectly.
Definition: VEVError.h:74
Indicates insufficient permissions for the current operations.
Definition: VEVError.h:56
Indicates an error occurred opening Safari during authorization via OAuth.
Definition: VEVError.h:105
Indicates an error occurred serializing/deserializing an authentication server response. This error implies a faulty authentication server and should be treated as unrecoverable.
Definition: VEVError.h:111
Indicates an error occurred on the authentication server.
Definition: VEVError.h:84
NSString *const VEVAuthorizationErrorDomain
The error domain for NSErrors that may result during authorization.
Definition: VEVError.h:12
NSString *const VEVNetworkErrorDomain
Error domain for NSErrors resulting from a Network problem.
Definition: VEVError.h:27
Indicates the authentication server is temporarily unavailable.
Definition: VEVError.h:89
Indicates the user is locked out.
Definition: VEVError.h:60
Indicates a client-side OAuth error occurred (e.g., because of a state mismatch or a misconfigured cl...
Definition: VEVError.h:95
VEVCacheError
Error codes that may result during cache operations.
Definition: VEVError.h:217
NSString *const VEVVaultServerErrorMessageKey
The error key for the underlying Vault error message.
Definition: VEVError.h:249
Indicates that the requested operation required a valid Vault session.
Definition: VEVError.h:150
Indicates an error occurred reading or saving the encrypted file.
Definition: VEVError.h:211
Indicates the cache cannot be opened.
Definition: VEVError.h:224
Indicates the user is not locally authenticated.
Definition: VEVError.h:198
Indicates client-side values in the applications Info.plist file are misconfigured.
Definition: VEVError.h:135
Indicates a misconfigured OpenID connect discovery configuration.
Definition: VEVError.h:69
Indicates the Vault session is invalid or expired.
Definition: VEVError.h:51
Indicates an unexpected error.
Definition: VEVError.h:194
VEVNetworkError
Error codes used if a network error occurs.
Definition: VEVError.h:237
NSString *const VEVCryptographyErrorDomain
Error domain for encryption errors.
Definition: VEVError.h:35
VEVVaultError
General error codes related to various Vault error conditions.
Definition: VEVError.h:157
Indicates an error occurred in the decryption process.
Definition: VEVError.h:206
Indicates the user canceled logging in.
Definition: VEVError.h:64
VEVAuthError
Error codes that may result during authorization.
Definition: VEVError.h:44
NSString *const VEVAPIErrorDomain
Error domain for API usage errors.
Definition: VEVError.h:31
Indicates an unknown error occurred during authorization via OAuth.
Definition: VEVError.h:140
Indicates there is no currently logged in user.
Definition: VEVError.h:228
VEVaultExceptionError
Error codes used if a Vault exception occurs.
Definition: VEVError.h:183
NSString *const VEVVaultRequestedVaultIDKey
The error key to retreive the Vault ID that resulted in a VEVVaultSelectedVaultUnavailableError.
Definition: VEVError.h:254
Indicates invalid login credentials.
Definition: VEVError.h:47
NSString *const VEVInvalidServerResponseKey
The error key for the underlying server response that resulted in a VEVAuthInvalidSecurityProfileErro...
Definition: VEVError.h:259
Indicates the requested operation requires that the user authenticate with Vault. ...
Definition: VEVError.h:145