This topic describes common PingOne top-level and detail API error messages that you might encounter when an error occurs. For more information about how top-level and detail API error messages are presented in an API workflow, see Errors.
Top-level error messages
The following table lists the top-level error messages, the response code, and common conditions that caused the error to occur.
|Code||Response code||Conditions||Default message||Examples|
|INVALID _DATA||400||Valid request structure received.
One or more data validation errors.
Each validation error should be described in a details object.
|The request could not be completed. One or more validation errors were in the request.||Create or update request with an attribute with an invalid data type.
Data failed validation rules.
Invalid value supplied for an enum.
|INVALID_REQUEST||400, 405, 406, 415||Invalid request received.
Malformed JSON, malformed HTTP request.
|The request could not be completed. The request was malformed or invalid.||The JSON structure was incorrectly formatted.
A POST request was submitted with a required body.
Incorrect Accept or Content-Type (although avoid 406/415 if possible).
Method not allowed on an endpoint (for example, POST to a URL that does not support POST).
|REQUEST_FAILED||400||Valid request structure received.
Error occurred during processing of the request (not strictly validation).
Each processing error should be described in a details object.
|The request could not be completed. There was an issue processing the request.||A password check action failed.|
|NOT_FOUND||404||URL specified is not found||The request could not be completed. The requested resource was not found.||Accessed a resource that does not exist.
Accessed a resource that has been hidden from the user (licensing, multi-tenancy concerns).
|ACCESS_FAILED||401, 403||Request failed due to authorization issue.||The request could not be completed. You do not have access to this resource.||Attempted a request with and expired, invalid or missing token.
Attempted a request where the token did not have permissions.
Attempted a request where the token is not licensed to request.
|REQUEST_LIMITED||429||Request was rate limited||The request could not be completed. A rate or quota limit was reached. Please try again later.||Rate limiting controls denied the request.
User is over quota for the request.
|UNEXPECTED_ERROR||500||Uncaught error occurred
Platform outage (502, 503, 500)
|There was an unexpected error with the service. Please try again later.||Service is down.|
Detail-level error messages
The following table lists the detail-level error messages, the response code, and common conditions that caused the error to occur.
|Code||Response code||Top-level match||Conditions||Default message||Examples|
|INVALID_VALUE||400||INVALID_DATA||INVALID_DATA top level error.||One or more issues were found in the request data.
The attribute is immutable and can not be updated.
Invalid value for attribute.
|Age must be a number.
Region must be “NA, EU or AU”.
Email must be in email format.
|INVALID_PARAMETER||400||REQUEST_FAILED||REQUEST_FAILED top level error.
Request contains a known query string parameter.
That parameter contains a value that can’t be processed.
|A query string parameter or value is not valid for this request.||Invalid cursor supplied using the “cursor” parameter.|
|INVALID_FILTER||400||REQUEST_FAILED||REQUEST_FAILED top level error.
Request contains a filter.
Syntax errors in that filter expression.
Unsupported operators included in filter expression.
|The specified filter was invalid.
The filter attribute was invalid or does not support filtering.
The value provided is invalid.
|Filter attribute is not filterable.
Filter operator was invalid or not supported.
Filter value was invalid or of a wrong type.
|REQUIRED_VALUE||400||INVALID_DATA||INVALID_DATA top level error.
Request is missing a required attribute.
|The request is missing a required value.||Username attribute is required to create a user.
Region is required to create an environment.
Attempted to update an environment and remove region.
|EMPTY_VALUE||400||INVALID_DATA||INVALID_DATA top level error.
Request attempted to clear an optional value (needs to be explicitly set to null).
Nulling or clearing a required value would result in a REQUIRED_VALUE error.
|The value cannot be empty.||Attempted to update a value to an empty string.|
|OUT_OF_RANGE||400||INVALID_DATA||INVALID_DATA top level error.
Value for attribute is out of a defined range.
|The request contains an attribute value that is outside the specified range.||Age must be between 1 and 150
Password length is too short.
|SIZE_LIMIT_EXCEEDED||400||INVALID_DATA||INVALID_DATA top level error.
Value for attribute is too large (either in size or length).
|The request contains an attribute value that is too large.||Given name must be <= 256 characters.
Image size must be < 10MB.
|QUOTA_EXCEEDED||429||REQUEST_LIMITED||A user, licensing or billing quota was exceeded.||The request will exceed your quota.||Daily SMS limit was exceeded.|
|LICENSE_EXCEEDED||403||ACCESS_FAILED||A licensing enforcement limit was reached.||The request exceeded your license limit.||Licensed for five environments, has five existing environments, an attempts to create another environment.|
|LIMIT_EXCEEDED||429||REQUEST_LIMITED||A rate limit was reached.||The request exceeded the allowed rate limit.||Too many request too quickly.|