Rate this page

Errors

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

Field Type Provided? Description
schemas array always SCIM schemas used in the error message. The schemas array will always include the value urn:ietf:params:scim:api:messages:2.0:Error to identify the message as an error. Other schema values may be present if Ping Identity-proprietary error fields are used.
status number always The HTTP status code of the error. This will always be 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 may contain error messages received from the underlying data store.

Example error:

{
    "schemas": [
        "urn:ietf:params:scim:api:messages:2.0:Error"
    ], 
    "scimType": "invalid_token", 
    "status": 401,
    "detail": "Access token is expired or otherwise invalid."
}

Password update errors

If an error response is returned because of a password update failure, then an additional field will be 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, which are rules that must be satisfied in order to successfully change a password. See here for a description of password quality requirements.

Example password update error:

{
     "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"
             }
         ]
     }
 }