NimbusSSO Error Codes
NimbusSSO returns an error code with a message if the JSON-RPC 2.0 request failed for some reason.
The errors and their codes fall into three ranges according to their category:
- -3000 .. -3099 SSO and session specific errors, such as on bad login credentials or expired session token (SID).
- -31100 .. -31199 Access denied messages, such as access denied due to a blocked client IP address.
- -32000 .. -32768 Standard JSON-RPC 2.0 protocol errors. These are codes reserved by the RPC protocol to indicate errors such as badly formatted JSON-RPC 2.0 requests or invalid method parameters.
Here is an example JSON-RPC 2.0 response that reports an -3010 error:
{ "error" : { "message" : "Invalid/expired session identifier (SID)",
"code" : -3010 },
"id" : "0001",
"jsonrpc" : "2.0" }
The exact format of error responses is described in the JSON-RPC 2.0 specification.
NimbusSSO keeps error messages deliberately concise. To obtain more information about the cause of an error examine the NimbusSSO log file (logging must be enabled at INFO level).
Single Sign-On (SSO) and session errors
This section lists JSON-RPC 2.0 errors indicating a user login or session exception.
| Code | Message |
|---|---|
| -3000 | Bad username/password |
| -3001 | User session quota exceeded |
| -3002 | Exceeded concurrent session quota of evaluation version |
| -3005 | Json2Ldap/LDAP connection retrieval not supported by backend |
| -3006 | Json2Ldap/LDAP connection retrieval denied |
| -3007 | Invalid user ID |
| -3010 | Invalid/expired session identifier (SID) |
| -3020 | Proxied login denied |
| -3021 | Proxied logout denied |
| -3022 | User listing denied |
| -3023 | Session listing denied |
| -3024 | Session event notifications denied |
| -3025 | Login denied |
| -3080 | Illegal HTTP URL |
| -3081 | Illegal LDAP DN |
| -3090 | AuthService/LDAP backend unavailable |
Access denied messages
This section lists JSON-RPC 2.0 errors indicating the client was denied access to NimbusSSO, e.g. due to a blocked client IP address.
| Code | Message |
|---|---|
| -31100 | Requests must be sent over HTTPS |
| -31105 | Client IP address denied access |
| -31110 | Trusted client X.509 certificate required |
| -31111 | Invalid client X.509 certificate principal DN |
| -31112 | Client X.509 certificate principal denied |
| -31120 | API key filter requires named JSON-RPC 2.0 parameters |
| -31121 | Missing API key |
| -31123 | API key denied access |
JSON-RPC 2.0 specific errors
The errors with codes between -3200 and -32768 are reserved by the JSON-RPC 2.0 standard to indicate protocol exceptions.
| Code | Message |
|---|---|
| -32700 | JSON parse error |
| -32600 | Invalid request |
| -32601 | Method not found |
| -32602 | Invalid parameters |
| -32603 | Internal error |
