PingDirectory API Reference

Errors

Like all other responses, errors are returned as SCIM responses with a media type of application/scim+json.

Some errors contain correlation IDs that can be used to troubleshoot. For more information, refer to Troubleshoot the SCIM 2.0 Servlet Extension.

Field Type Provided? Description

schemas

array

always

SCIM schemas used in the error message. The schemas array always includes the value urn:ietf:params:scim:api:messages:2.0:Error to identify the message as an error. Other schema values can be present if Ping Identity-proprietary error fields are used.

status

number

always

The HTTP status code of the error. This is always in the 400 or 500 range.

scimType

string

An error code defined by RFC 7644, section 3.12.

detail

string

A human-readable error description. In some cases, this field contains a correlation ID corresponding to log messages on the endpoint server.

 
{
    "schemas": [
        "urn:ietf:params:scim:api:messages:2.0:Error"
    ],
    "status": "400",
    "detail": "Request failed: correlationID='269bb1a8-8c51-48b3-83a0-380e1d4b4ab9'"
}

Password update errors

If an error response is returned because of a password update failure, an additional field is provided under the urn:unboundid:scim:api:messages:2.0:PasswordUpdateError schema URN.

Field Type Provided? Description

passwordRequirements

array

An array of password quality requirements. These are rules that must be satisfied in order to successfully change a password.

 
{
     "detail": "The provided new password cannot be the same as the current password or any password in the user's password history",
     "schemas": [
         "urn:pingidentity:scim:api:messages:2.0:PasswordUpdateError"
     ],
     "scimType": "invalidValue",
     "status": 400,
     "urn:pingidentity:scim:api:messages:2.0:PasswordUpdateError": {
         "passwordRequirements": [
             {
                 "additionalInfo": "The provided new password cannot be the same as the current password or any password in the user's password history.",
                 "description": "The new password must not be the same as the current password.",
                 "requirementSatisfied": false,
                 "type": "notCurrentPassword"
             }
         ]
     }
 }