HTTP Status Codes - ULM / DIM — SaaS Knowledge Center

Digital Identity Management responds to API requests with standard HTTP status codes. If the API fails to validate a request, it will also respond with a business error code in the response payload.

Classifications

HTTP response codes are grouped into five different classes. Each class represents an overarching response type (e.g. “server error”) and each individual status code denotes a particular type of response that is occurring:

100-199 – Informational responses
200-299 – Successful
300-399 – Redirects
400-499 – Client errors
500-599 – Server errors

The tables below detail the response codes that are specifically used by Digital Identity Management.

Successful Responses

Status	Message	Description
200	OK	GET	Response contains an entity corresponding to a request. If the response contains multiple entities, then it may or may not include the original entity used in the request. Many Digital Identity Management APIs are used to retrieve a list of entities associated to an entity specified in the request. For example, `GET /user/{userId}/runtime` will retrieve all runtimes associated the specified user. Most APIs of this type will include an original entity specified in the request, but some will not.
POST	Response contains an entity describing or containing the result of a successful action. For example, the successful POST /user will return a newly created user entity along with any additional properties or attributes not originally supplied in the request, such as `createdDate` and status data fields. Successful PUT and PATCH requests generally do not return any content other than the “OK” or “Successful” message, but there may be exceptions.
DELETE	Request was successful, and the target resource is now deleted or deactivated. No additional content is returned.
201	Success	Request has been fulfilled, typically resulting in the creation of a new resource. Usually, it does not include any additional content in the payload.
204	No Content	Request was successful, but there is no content in the response.

Redirect Responses

Status	Message	Description
301	Moved Permanently	The URL servicing the request has permanently moved; the new URL is included as part of the response.
302	Found	The URL servicing the request has temporarily moved. Clients should continue using the same URL to appropriately redirect to new locations in the future. Most often, it is used by the social onboarding/authentication/association Processes (to redirect to a specified social identity provider), or during OIDC flows for Single-Sign On.

Failed or Denied Responses

Failed or denied requests are categorized as either client-driven or server-driven errors.

Status	Message	Description
400	Bad Request	General user input error (e.g., field validation error).
401	Unauthorized	The request fails due to missing authorization.
403	Forbidden	Existing authorization does not allow user to access a protected resource.
404	Not Found	The requested resource was not found.
405	Method Not Allowed	Incorrect HTTP method used for the request.
406	Not Acceptable	Incorrect media type or content type in the request.
409	Conflict	Data supplied in the request conflicts with existing data in the Digital Identity Management database.

Status	Message	Description
500	Internal Server Error	General server error
501	Not Implemented	The server does not support the functionality required to fulfill the request.
502	Bad Gateway	The server, while acting as a gateway or proxy, received an invalid response from an inbound server it accessed while attempting to fulfill the request.
503	Service Unavailable	The server is currently unable to handle the request due to a temporary overload or scheduled maintenance.

Parent topic:Status Codes and Errors