After submitting a call, you receive a response message to inform you that your request was received and processed.
Depending on the HTTP status code of the response message, it is helpful to build some logic to handle any errors that a request or the system may return.
HTTP Responses
200 - OK The request has succeeded.
Show more Show less Show children Hide children
Show children Hide children
Show children Hide children
The next page. Only present if there is a next page.
Show children Hide children
The previous page. Only present if there is a previous page.
Show children Hide children
Show children Hide children
Show children Hide children
References to resources connected with this user.
Show children Hide children
Link to the resource itself.
Show children Hide children
Indicates whether this user is active.
Set of apps available to this user
The email address of the user.
The unique identifier of the user.
Show children Hide children
The list of roles for this user.
The tz database name of the time zone of the user. For example, Europe/Amsterdam .
Min length: 1 Max length: 255
The username for this user.
204 - No Content The request has been successfully processed, but there is no additional content.
400 - Bad Request A problem reading or understanding the request.
Show more Show less A human-readable explanation specific to this occurrence of the problem.
A code that identifies the problem type.
A unique URI that identifies the specific occurrence of the problem.
Detailed explanation of each validation error, when applicable.
Show children Hide children
Description of the validation error.
The field that has an invalid value.
A unique reference for the request, essentially the same as pspReference.
A short, human-readable summary of the problem type.
A URI that identifies the problem type, pointing to human-readable documentation on this problem type.
401 - Unauthorized Authentication required.
Show more Show less A human-readable explanation specific to this occurrence of the problem.
A code that identifies the problem type.
A unique URI that identifies the specific occurrence of the problem.
Detailed explanation of each validation error, when applicable.
Show children Hide children
Description of the validation error.
The field that has an invalid value.
A unique reference for the request, essentially the same as pspReference.
A short, human-readable summary of the problem type.
A URI that identifies the problem type, pointing to human-readable documentation on this problem type.
403 - Forbidden Insufficient permissions to process the request.
Show more Show less A human-readable explanation specific to this occurrence of the problem.
A code that identifies the problem type.
A unique URI that identifies the specific occurrence of the problem.
Detailed explanation of each validation error, when applicable.
Show children Hide children
Description of the validation error.
The field that has an invalid value.
A unique reference for the request, essentially the same as pspReference.
A short, human-readable summary of the problem type.
A URI that identifies the problem type, pointing to human-readable documentation on this problem type.
422 - Unprocessable Entity A request validation error.
Show more Show less A human-readable explanation specific to this occurrence of the problem.
A code that identifies the problem type.
A unique URI that identifies the specific occurrence of the problem.
Detailed explanation of each validation error, when applicable.
Show children Hide children
Description of the validation error.
The field that has an invalid value.
A unique reference for the request, essentially the same as pspReference.
A short, human-readable summary of the problem type.
A URI that identifies the problem type, pointing to human-readable documentation on this problem type.
500 - Internal Server Error The server could not process the request.
Show more Show less A human-readable explanation specific to this occurrence of the problem.
A code that identifies the problem type.
A unique URI that identifies the specific occurrence of the problem.
Detailed explanation of each validation error, when applicable.
Show children Hide children
Description of the validation error.
The field that has an invalid value.
A unique reference for the request, essentially the same as pspReference.
A short, human-readable summary of the problem type.
A URI that identifies the problem type, pointing to human-readable documentation on this problem type.