Common HTTP errors

Here are the most common HTTP error codes returned by the APIs in case of anomalies.

For details, please consult the documentation for each individual API

Fault code Description
400 BAD REQUEST A request was made with invalid parameters or message body elements, e.g: - You are trying to save a user specifying the code of an invalid reference user - You are trying to link an element to a hierarchy node that does not exist
401 UNHAUTORIZED "Authorization failure. The authorization header is invalid or missing." In the case of BASIC authentication, this occurs if: - the username or password is invalid - if the option is checked for the user In the case of OAUTH2 authentication: - If the content of the token is not recognised
403 FORBIDDEN "Access not granted" or"Access not granted for function XXX". The user does not have the appropriate role to perform the requested operation via API. Examples: - You are trying to save a new user via the SCIM API but you have read-only access to the user database - You are trying to read the audit data via ODATA without having access to the Repository Normally, the body of the response contains the function that is required to perform that operation. - If the HTTP verb used is DELETE, PATCH, POST or PUT, read/write rights are required - If the HTTP verb used is GET, read-only rights are normally sufficient.
500 INTERNAL SERVER ERROR This is an operational anomaly for which specific support is needed. Equivalent to error messages not handled within the application
503 SERVICE UNAVILABLE Public APIs have been disabled in the configuration. To enable them, see Activation.