Identity Management API Debugging

This section tells you about the Identity Management API’s error response format, and details the range of HTTP status codes the API produces.

Error Responses

The Identity Management API responds with HTTP problem error objects that provide details useful for debugging.

The following shows a typical error response. The outer object characterizes the overall problem, while the errors array lists potentially more than one problem detected in the request.

{
    "type" : "/identity-management/error-types/3",
    "status" : 403,
    "title" : "no access",
    "instance" : "",
    "detail" : ""
    "errors" : [ ],
}

HTTP Status Codes

The following lists the range of HTTP response codes the API may produce for both success and error cases:

Code Description
200 Request OK
201 Resource created
401 Unauthorized request
402 Failed request
403 Forbidden
404 Resource not found
405 Method not allowed
415 Unsupported media type
429 Too many requests
500 Internal Server Error
503 Service Unavailable

Last modified: 1/17/2017