Error codes

Json2Ldap returns an error code with a message if the JSON-RPC 2.0 request failed for some reason.

The error codes fall into the following ranges according to their type:

Here is an example JSON-RPC 2.0 response that reports an invalid / expired LDAP connection token:

{ "error"   : { "code"    : -1000,
                "message" : "Invalid\/expired LDAP connection identifier (CID)" },
  "id"      : 1,
  "jsonrpc" : "2.0" }

Some error responses may contain additional diagnostic information in the error data field, for example:

{
 "error"   : { "code"    : -1031,
               "message" : "LDIF exception",
               "data"    : "Unexpected space found at the beginning of
                            the first line for an LDIF entry on or near
                            line number 1."},
 "id"      : 1,
 "jsonrpc" : "2.0"
}

The exact format of error responses is described in the JSON-RPC 2.0 specification.

Json2Ldap keeps error messages deliberately concise. To obtain more information about the cause of an error examine the Json2Ldap log file (logging must be enabled at INFO level).

LDAP specific errors

Errors with a code above zero indicate an exception reported by the directory server during processing of an LDAP request. The codes can be standard, reserved by the LDAP protocol (codes in the range from 0 to 90, see RFC 2251) as well as extension specific (codes above 90).

The encapsulating HTTP response has a status code 460 (since v3.5).

Here is a list of some of the LDAP specific errors:

Json2Ldap specific exceptions

Exceptions with codes between -1000 and -1999 originate from the Json2Ldap web service itself.

These are divided into the following categories:

• -1000 .. -1099 Common errors

• -1100 .. -1199 LDAP server connection, TLS/SSL and network errors

• -1200 .. -1299 Bind (authentication) request errors

• -1300 .. -1399 Errors related to LDAP read operation requests

• -1400 .. -1499 Errors related to LDAP write operation requests

• -1500 .. -1599 Errors related to LDAP extended requests

• -1600 .. -1699 Errors related to LDAP schema information requests

• -1700 .. -1799 Custom Json2Ldap extension errors

The encapsulating HTTP response has a status code 461 (since v3.5).

Here is the complete list of the Json2Ldap web service specific errors:

Access denied messages

This section lists JSON-RPC 2.0 errors indicating the client was denied access to Json2Ldap, e.g. due to a blocked client IP address.

The encapsulating HTTP response has a status code 401 or 403 (since v3.5).

JSON-RPC 2.0 specific errors

Errors with codes between -32000 and -32768 are reserved by the JSON-RPC 2.0 specification to indicate a general protocol exception.

The encapsulating HTTP response has a status code 400 except for the -32603 Internal error where the HTTP status code is 500 (since v3.5).