Last updated December 6th, 2023
The Knox MSP Portal API uses conventional HTTP response codes to indicate the success or failure of a request. A 2XX response code indicates success, a 4XX response code indicates a client-side error due to the request inputs, and a 5XX response code indicates a server-side error. There are also custom error codes specific to the Knox MSP Portal API listed below.
Each error response contains a JSON body with additional information about the error. The error objects contain the following attributes:
|A string used to identify the exact transaction that returned the error object.
|The name of the error code.
|The error code number. If it’s unique to the Knox MSP Portal, it’s a more specific indicator of the error than the HTTP response code.
|A description of the error, intended to help developers debug the error response.
Following is an example 403 response:
HTTP/1.1 403 Unauthorized
"errorMessage": "The current user is unauthorized to use this service."
Standard HTTP error codes
The following table lists the most common HTTP error responses:
|The request was successfully received.
|The client has issued an invalid request. Verify your request (for instance, check validation errors in your request payload).
|Authorization for the API is required, but the request has not been authenticated.
|The request has been authenticated but does not have the appropriate permissions, or the requested resource cannot be found.
|The requested path or the specified user does not exist.
|The request could not be completed due to a conflict with the current state of the target resource.
|An error has occurred on the server. Please try again later.
Knox MSP Portal error codes
The Knox MSP Portal API uses custom error codes which provide more information than the standard HTTP error response codes. The following table lists the Knox MSP Portal API error codes and their descriptions:
|Internal Server Error.
|The current user is unauthorized to use this service.
|This customer doesn’t exist or the ID isn’t a valid customer ID.
|This customer is currently either pending approval or has been rejected by the Samsung administrator.
|This customer is currently in the process of being delinked from an MSP and cannot be added until this process is complete.
|This customer is already managed by someone else.
|This customer is ‘Pending’ and cannot be added again.
|This customer is not available in your region.
|This customer doesn’t exist.
|Customer not managed by the current MSP.
|A Knox Cloud Services account already exists for this user. Please contact the customer or Samsung administrator.
|The Knox MSP Portal API does not support Samsung Care Plus.
|Cannot delink a fully managed customer.
|Customer is in pending state, cannot be delinked.
|Prefix can’t begin or end with a period.
|Prefix is required because the domain name already exists.
|This email domain is not allowed for jointly managed customers.
|Customer cannot be changed while delink request is pending.
|Can’t update from jointly managed to fully managed.
|Service not associated with this customer’s account.
|Customer can’t be changed while in pending to link status.
Access type param is required when adding new services.
|The organization domain is already in use. Please add a prefix to uniquely identify your organization or to manage multiple Knox Manage administrator accounts under the same organization.
If your request returns a 400 level error
Find the specific error code in the table above and refer to the error message for details.
If your request returns a 500 level error
Please try the request again at a later time.
Is this page helpful?