Skip to content

/problems/forbidden-resource⚓︎

Problem

This is a description of a specific error response that you can receive when using the INVERS OneAPI via REST.1

Check out our API Basics to learn more about the basic structure of all error responses and to find out how you should handle them.

{
    "type": "/problems/forbidden-resource",
    "type_documentation": "https://developers.invers.com/problems/forbidden-resource",
    "title": "Accessing this resource is forbidden.",
    "status": 403,
    "detail": "…",
    "flow_id": "721d1bd4-b3a6-4ff0-8a2a-cc6ce7526541"
}

Meaning⚓︎

This problem type occurs when sending a request using credentials that do not have the scope required in order to access the requested resource.

Details⚓︎

  • Use the error response’s type property to handle specific errors and exception handling within your application. It’s comparable to an error code.
  • The detail property contains additional, more human-readable information about the problem or error. This is explanatory text and you should not have any exception handling and error handling code depend on it, as it may change.

Detail examples⚓︎

The following examples are typical texts which you might receive in the error response’s detail property. Note that it is not a complete list of all possible cases. Therefore expect to receive error responses with a detail property value not listed below.

Example problem details⚓︎

A scope required to access this resource is not granted.

You have sent a request with credentials that are valid, but missing the correct OAuth scope.

Possible solutions:

- Consult the corresponding API documentation to verify that you are in fact making the request you intended to
- Contact the INVERS support if you are under the impression that the scope should have been granted to you

Further reading⚓︎


  1. The flow_id is specific to each API call, so it will be different in your case. However, type, title and status will match your actual error response if you receive the error described on this page.