This section describes When errors/exception occur in the system, the API Manager throws XML-based error responses by default. To change the format of the error response that is sent to the client, you change the auth failure handler in the <AM_HOME>/repository/deployment/server/synapse-configs/default/sequences/_auth_failure_handler.xml file. Given below is the default configuration:
| Code Block | ||
|---|---|---|
| ||
<sequence name="auth_failure_handler">
<property name="error_message_type" value="application/xml"/>
<sequence key="build"/>
</sequence> |
If you change application/xml to something like applicatoin/json, the error response will be sent in JSON format.
Given below are some error codes and their meanings.
...
| Error code | Error Message | Description |
|---|---|---|
900900 | Unclassified Authentication Failure. | An unspecified error has occurred |
900901 | Invalid Credentials | Invalid Authentication information provided |
900902 | Missing Credentials | No authentication information provided |
900903 | Access Token Expired | Access Token has expired. Renew the access token. |
900904 | Access Token Inactive | Access token has become inactive. Generate new access token. |
900905 | Incorrect Access Token Type is provided | The access token provided is in different privilege level than the invoked API is designated totype used is not supported when invoking the API. The supported access token types are Application Accesses Token and User Accesses Token. See Access Tokens. |
900906 | No matching resource found in the API for the given request | A resource with the name in the request can not be found in the API. |
900907 | The requested API is temporarily blocked | The status of the API has been changed to an inaccessible/unavailable state. |
900908 | Resource forbidden | do not have The user invoking the API has not been granted access to resource in users privilege levelthe required resource. |
900909 | The subscription to the API is inactive | This happens Happens when the API user has been is blocked. |
900910 | The access token does not allow you to access the requested resource | Can not access the required resource with the provided access token provided. Check the valid resources that can be accessed with the this token. |
900800 | Message throttled out | The maximum number of requests that can be made to the API for within a designated time has been period is reached and the API has been is throttled for the user. |
Sequences error codes
| Error code | Description |
|---|---|
900901 | Production/sandbox key offered to the API with no production/sandbox endpoint |
403 | No matching resource found in the API for the given request |
...