Request headers

Header Name Description
Cache-Control The Cache-Control general-header field is used to specify directives that MUST be obeyed by all caching mechanisms along the request/response chain. In our authentication request the header is mandatory with the value. Cache-Control: no-cache
Content-Type The content type of the resource in case the request has content in the body. Example: Content-Type:multipart/form-data;boudary=<calculated when request is sent>
Authorization A valid access token required for authorization
Accept The Accept request-header can be used to specify the media types which are acceptable for the response. Example: Accept:application/json

Response codes

Code Name Description Common/Possible Reasons Example
200 OK Request succeeded Everything processed as expected A GET call successfully retrieves user data
201 Created Resource has been created Successfully created a resource or request A POST call creates a new workflow
202 Accepted Request has been accepted for processing, but not yet completed Long-running operations submitted for processing asynchronously A POST call is accepted and queued for processing, returning a 202 status while the operation continues asynchronously
204 No Content Request succeeded but no content to return The operation was successful but there’s no data to return A DELETE call successfully deletes a user without returning content
400 Bad request Server cannot process the request due to error Malformed syntax or wrong configuration A POST call with invalid JSON data results in a 400 error.
No default configuration found for your tenant and client
401 Unauthorized Authentication required: missing or invalid access token Missing or invalid authentication credentials A GET call without a valid token
403 Forbidden Not Authorized: Authenticated, but user has no access to the API User authenticated, but does not have permission to access the resource A DELETE call with no correct scopes for deleting
404 Not Found Resource not found Resource does not exist on the database A GET call for a non-existent registry
409 Conflict The request could not be completed due to a conflict with the current state of the resource Concurrency control issues, or conflicting updates on a resource A PUT call attempts to update a user with a version conflict, such as trying to update a resource that has been modified elsewhere concurrently
500 Internal server error Server encountered an unexpected condition Generic error message when server fails to fulfill the request A GET call encounters a server issue like database failure, event could not be send, etc)
503 Service unavailable Server is currently unavailable Server overload or down for maintenance A GET call when the server is down for maintenance