Api Errors
/// tab | Applications
| Error code | Http status code | Error message | Description |
|---|---|---|---|
| APP_001 { #APP_001 } | 409 | Application with entity_id {} already exists | This error occurs when application creation is attempted with an application that already exists |
| APP_002 { #APP_002 } | 404 | Resource not found for {} entity_id {} | This error occurs when a resource with the specified entity_id is not found in the system |
| APP_003 { #APP_003 } | 409 | {} | This error occurs when an application with the specified name already exists in TID |
| APP_004 { #APP_004 } | 400 | {} | This error occurs when there is an issue creating an application in TID |
| APP_005 { #APP_005 } | 404 | Application not found for entity_id {} | This error occurs when an application with the specified entity_id is not found |
| APP_006 { #APP_006 } | 403 | User not authorized to create applications | This error occurs when user does not have permission to create applications |
| APP_007 { #APP_007 } | 403 | User not authorized to add applications to account | This error occurs when user does not have permission to create applications in a specific account |
| APP_008 { #APP_008 } | 404 | Error while unlinking account from application {} | This error occurs when an application is not found during unlink account from application |
| APP_009 { #APP_009 } | 404 | Error while deleting application {} | This error occurs when an application is not found during deletion of an application |
| APP_010 { #APP_010 } | 404 | Error while deleting the app from TID {} | This error occurs when an application is not found in TID during deletion of an application |
| APP_011 { #APP_011 } | 403 | User not authorized to get applications | This error occurs when user does not have permission to get applications |
| APP_012 { #APP_012 } | 403 | Not authorized to update applications | This error occurs when the caller does not have permission to update application |
| APP_013 { #APP_013 } | 403 | User not authorized to delete applications | This error occurs when user does not have permission to delete application |
| APP_014 { #APP_014 } | 403 | Not authorized to add user to application | This error occurs when user does not have permission to add user to an application |
| APP_015 { #APP_015 } | 403 | Not authorized to assign role | This error occurs when user does not have permission the assign role to an application |
| APP_016 { #APP_016 } | 404 | User not found for id {} | This error occurs when the user cannot find the specified user for adding in application |
| APP_017 { #APP_017 } | 409 | User with id {} already added to given application | This error occurs when the user is already added to the application. |
| APP_018 { #APP_018 } | 404 | Related accounts not found for application {} | This error occurs when user cannot find the resource accounts related to the application |
| APP_019 { #APP_019 } | 400 | Subscription already existing between {} and {} application | This error occurs when a subscription between proxy and client application already exists |
| APP_020 { #APP_020 } | 404 | No subscription exist between {} and {} applications | This error occurs when No subscription data is found between proxy and client application |
| APP_021 { #APP_021 } | 404 | Proxy application {} not exist | This error occurs when proxy application not found |
| APP_022 { #APP_022 } | 404 | Client application {} not exist | This error occurs when client application not found |
| APP_023 { #APP_023 } | 403 | Role {} is scoped to a different account | This error occurs when the role is scoped to a different account than the one being accessed |
| APP_024 { #APP_024 } | 403 | Not authorized to access other application role {} | This error occurs when Application not authorized to access other application roles |
| APP_025 { #APP_025 } | 404 | Role {} not found | This error occurs when Application could not find the role specified |
| APP_026 { #APP_026 } | 403 | Applications are not authorised to perform this creation operation | Error occurs when an application tries to create other application which is not allowed |
| APP_027 { #APP_027 } | 400 | ‘applicationLogo’ key is missing in the request | Error occurs during adding consent details, the request is missing ‘applicationLogo’ key |
| APP_028 { #APP_028 } | 400 | Unsupported media type {} | Error occurs during adding consent details, the request contains unsupported media type |
| APP_029 { #APP_029 } | 400 | {} is invalid or missing in the request | Error occurs during adding consent details, the request contains invalid url |
| APP_030 { #APP_030 } | 400 | Failed to add consent details | Unexpected error while adding consent details due to unknown error |
| APP_031 { #APP_031 } | 404 | Consent details not found for application {} | Consent details not found for application with the specified entity_id |
| APP_032 { #APP_032 } | 404 | Application not found for entity_id {}. Please find the data in region: {} | This error occurs when an application with the specified entity_id is not found |
| APP_033 { #APP_033 } | 400 | {} | This error occurs when application update raised validation error in TID |
| APP_034 { #APP_034 } | 400 | Cannot add user to application when user is in PENDING state | This error occurs when trying to add a user who is in PENDING state to an application |
| APP_035 { #APP_035 } | 500 | Internal server error occurred while processing the request | This error occurs when the db transaction is failed |
| APP_036 { #APP_036 } | 404 | Application {} is not subscribed to account {} | This error occurs when trying to authorize an application that is not subscribed to the account |
| APP_037 { #APP_037 } | 409 | Application {} is already authorized on account {} | This error occurs when trying to authorize an application that is already authorized on the account |
| APP_038 { #APP_038 } | 400 | Application {} is not authorized on account {} | This error occurs when trying to deauthorize an application that is not authorized on the account |
| APP_039 { #APP_039 } | 409 | Application {} already subscribed to account {} | This error occurs when an application is already subscribed to the account |
| APP_040 { #APP_040 } | 400 | Invalid filter query | This error occurs when the provided filter query is not valid or cannot be parsed |
| APP_041 { #APP_041 } | 403 | User not authorized to list accounts for application | This error occurs when user does not have permission to list accounts for an application |
| APP_042 { #APP_042 } | 403 | Application {} is not part of the calling subject’s account | This error occurs when the application is not linked to the calling subject’s account |
| APP_043 { #APP_043 } | 403 | Not allowed to perform action on application: {} | This error occurs when trying to perform an action on an application managed by a device |
| APP_044 { #APP_044 } | 403 | Not authorized to list users for application | This error occurs when the caller does not have permission to list users for an application |
| APP_045 { #APP_045 } | 400 | Invalid {} Id {} | Error occurs when the provided ID is not in UUID format |
| APP_046 { #APP_046 } | 400 | Invalid include query parameter | This error occurs when any of the provided include query parameters is not supported |
| APP_050 { #APP_050 } | 403 | Not authorized to create api products | This error occurs when caller is not authorized to create api products |
| APP_051 { #APP_051 } | 403 | Not authorized to get api products | This error occurs when caller is not authorized to get api products |
| APP_052 { #APP_052 } | 403 | Not authorized to delete api products | This error occurs when caller is not authorized to delete api products |
| APP_053 { #APP_053 } | 404 | Api product not found for id {} | This error occurs when requested api product is not found |
| APP_054 { #APP_054 } | 409 | scopePrefix {} is already in use | This error occurs when scopePrefix conflicts with an existing api product |
| APP_055 { #APP_055 } | 404 | Logo does not exist | This error occurs when the requested logo for application does not exist when trying to get application logo |
| APP_056 { #APP_056 } | 400 | Application {} cannot be authorized on account {} with provisioning status {} | This error occurs when trying to authorize an application whose account relation has an unsupported provisioning status |
| APP_057 { #APP_057 } | 409 | An application with isScimIntegrationEnabled already exists in account {} | Only one application per account can have isScimIntegrationEnabled set to true |
| APP_058 { #APP_058 } | 403 | Not authorized to create application secrets | This error occurs when caller does not have permission to create application secrets |
| APP_059 { #APP_059 } | 404 | Secrets not found for application {} | This error occurs when no secrets are found for the specified application |
| APP_060 { #APP_060 } | 400 | {} | This error occurs when TID rejects an application secret request |
| APP_061 { #APP_061 } | 403 | Not authorized to view application secrets | This error occurs when caller does not have permission to view application secrets |
| APP_062 { #APP_062 } | 409 | Application {} has reached the maximum number of secrets ({}) | This error occurs when an application already has the maximum allowed number of secrets |
| APP_063 { #APP_063 } | 403 | Application {} is not public and cannot be authorized on account {} | This error occurs when authorizing an application on an account other than its home account while the application is not marked public |
| APP_250 { #APP_250 } | 400 | DPoP proof validation failed | This error occurs when the DPoP proof is invalid (missing/malformed proof, bad signature, htm/htu mismatch, or jti replay) |
| APP_251 { #APP_251 } | 401 | DPoP token binding failed | This error occurs when DPoP token binding fails (ath mismatch, cnf.jkt mismatch, or Bearer used with a DPoP-bound token) |
| APP_400 { #APP_400 } | 400 | Generic message: ‘Spec mismatch error’ | This error occurs when there is a mismatch between the OpenAPI spec and the request submitted. Please verify the request against the spec. If you notice the error is not a spec mismatch raise a support ticket |
| APP_500 { #APP_500 } | 500 | Generic message: ‘Internal server error’ | This error occurs due to some internal problem. Immediately raise a support ticket |
| /// |
/// tab | Devices
| Error code | Http status code | Error message | Description |
|---|---|---|---|
| DEV_001 { #DEV_001 } | 400 | GroupId is invalid | This error occurs when create device payload is invalid groupId |
| DEV_002 { #DEV_002 } | 404 | Account not found | This error occurs when create device has an accountId that does not exist |
| DEV_003 { #DEV_003 } | 404 | Group not found | This error occurs when create device has a groupId that does not exist |
| DEV_004 { #DEV_004 } | 403 | Not authorized to perform create devices | This error occurs when user does not have permission to create devices |
| DEV_005 { #DEV_005 } | 403 | Not authorized to perform create devices in group | This error occurs when user does not have permission to create devices in the specified group |
| DEV_006 { #DEV_006 } | 409 | Device Id already exists | This error occurs create device has a deviceId that already exists |
| DEV_007 { #DEV_007 } | 409 | Device already exists. {} combination must be unique. | This error occurs create/update device has a combination keys that already exists |
| DEV_008 { #DEV_008 } | 404 | Device not found | This error occurs when a device does not exist |
| DEV_009 { #DEV_009 } | 403 | Not authorized to perform update devices | This error occurs when user does not have permission to update devices |
| DEV_010 { #DEV_010 } | 400 | DeviceId is not valid | This error occurs when given payload has an invalid DeviceId |
| DEV_011 { #DEV_011 } | 403 | Not authorized to perform read devices | This error occurs when user does not have permission to read devices |
| DEV_012 { #DEV_012 } | 403 | Not authorized to perform delete devices | This error occurs when user does not have permission to delete devices |
| DEV_013 { #DEV_013 } | 409 | Device cannot be deleted. Device is associated to group. | This error occurs when device cannot be deleted because it is associated with a group |
| DEV_014 { #DEV_014 } | 409 | Device cannot be deleted. Device is associated to certificates. | This error occurs device cannot be deleted because it is associated with certificates |
| DEV_015 { #DEV_015 } | 403 | Not authorized to transfer device | This error occurs when user does not have permission to transfer devices |
| DEV_016 { #DEV_016 } | 409 | Device already associated with the target account | This error occurs device already associated with the account specified in the transfer request |
| DEV_017 { #DEV_017 } | 400 | Device already has a pending transfer | This error occurs when a transfer has already been initiated for device and is pending completion |
| DEV_018 { #DEV_018 } | 403 | Not authorized to perform action | This error occurs during device transfer when user does not have permission to access the target account |
| DEV_019 { #DEV_019 } | 404 | No active transfer found for this device | This error occurs when trying to get transfer status for a device with no active transfer |
| DEV_020 { #DEV_020 } | 403 | Not authorized to get device transfer status | This error occurs when the user does not have permission to check device transfer status |
| DEV_021 { #DEV_021 } | 400 | Action is required | This error occurs when transfer action is not provided |
| DEV_022 { #DEV_022 } | 400 | Invalid action: {} | This error occurs when provided transfer action is not valid |
| DEV_023 { #DEV_023 } | 400 | No device relation found with status: {} | This error occurs when device relation with specified status is not found |
| DEV_024 { #DEV_024 } | 400 | No active transfer found for device with account id {} | This error occurs when target account ID does not match pending transfer account |
| DEV_025 { #DEV_025 } | 403 | Not authorized to {} transfer request | This error occurs when user does not have permission to perform transfer action |
| DEV_026 { #DEV_026 } | 403 | Not authorized to perform search devices | This error occurs when the user does not have permission to search devices |
| DEV_027 { #DEV_027 } | 404 | Could not find device with the given search criteria | This error occurs when no device matches the provided search criteria |
| DEV_028 { #DEV_028 } | 404 | Resource not found | This error occurs when resource with the specified ID does not exist |
| DEV_029 { #DEV_029 } | 400 | Group is related to multiple accounts | This error occurs when group is assigned to multiple accounts |
| DEV_030 { #DEV_030 } | 400 | Invalid filter query | This error occurs when DB query filter is not valid |
| DEV_031 { #DEV_031 } | 403 | Not authorized to perform read account | This error occurs when the user does not have permission to read account |
| DEV_032 { #DEV_032 } | 404 | Group Account relation not found | This error occurs when the user could not find account relation for the specified group |
| DEV_033 { #DEV_033 } | 400 | Device already has 5 certificates mapped | This error occurs when trying to create more than 5 certificates for a device |
| DEV_034 { #DEV_034 } | 400 | CertificateId is not valid | This error occurs when trying delete a certificate with an invalid CertificateId |
| DEV_035 { #DEV_035 } | 403 | Not authorized to perform {} {} | This error occurs when the user does not have permission to perform the specified action on certificates |
| DEV_036 { #DEV_036 } | 403 | Certificate association with device not found | This error occurs when the user could not find a certificate associated with the specified device |
| DEV_037 { #DEV_037 } | 400 | Invalid certificate request: One of certCommonName, csr, or caCertOrigin must be provided. | This error occurs when the certificate request is missing required fields |
| DEV_038 { #DEV_038 } | 500 | Trouble processing certificate request | This error occurs when the certificate is invalid |
| DEV_039 { #DEV_039 } | 409 | Certificate ID already exists | This error occurs when trying to create a certificate with an ID that already exists |
| DEV_040 { #DEV_040 } | 404 | Certificate not found | This error occurs when attempting to access a certificate that does not exist |
| DEV_041 { #DEV_041 } | 404 | Device Account relation not found | This error occurs when attempting to find device-account relation that does not exist |
| DEV_042 { #DEV_042 } | 400 | publicKey should not be empty | This error occurs when public key is empty |
| DEV_043 { #DEV_043 } | 400 | sku should not be empty | This error occurs when sku is empty |
| DEV_044 { #DEV_044 } | 400 | PreferredDeviceId is not a valid GUID | This error occurs when GUID is not valid |
| DEV_045 { #DEV_045 } | 400 | manufacturer should not be empty | This error occurs when manufacturer is empty |
| DEV_046 { #DEV_046 } | 400 | model should not be empty | This error occurs when model is empty |
| DEV_047 { #DEV_047 } | 400 | unlockCertRotation should not be empty | This error occurs when unlockCertRotation is empty |
| DEV_048 { #DEV_048 } | 400 | unlockCertRotation field can only be set to True | This error occurs when unlockCertRotation is set to false |
| DEV_049 { #DEV_049 } | 400 | PublicKey should be of type RSA or ECDSA | This error occurs when unlockCertRotation is set to false |
| DEV_050 { #DEV_050 } | 400 | Error validating public key | This error occurs when public key is invalid |
| DEV_051 { #DEV_051 } | 400 | Missing required fields - {} | This error occurs when required field is missing |
| DEV_052 { #DEV_052 } | 400 | {} should not be empty | This error occurs when required field is empty |
| DEV_053 { #DEV_053 } | 400 | Invalid search condition: Either sku or both model, manufacturer should be provided | This error occurs when search condition is invalid |
| DEV_054 { #DEV_054 } | 400 | Field required - serialNumber | This error occurs when serialNumber field not provided |
| DEV_055 { #DEV_055 } | 400 | certCommonName cannot be combined with csr, caCertOrigin, or publicCert | This error occurs when common name (CN) used in combination with other certificates |
| DEV_056 { #DEV_056 } | 400 | csr cannot be combined with caCertOrigin, publicCert or certCommonName | This error occurs when csr used in combination with other certificates |
| DEV_057 { #DEV_057 } | 400 | caCertOrigin and publicCert must be provided together | This error occurs when both dependent cert details not provided |
| DEV_058 { #DEV_058 } | 400 | At least one of certCommonName, csr, or caCertOrigin must be provided. | This error occurs when not even one cert detail provided |
| DEV_059 { #DEV_059 } | 400 | {} cannot be null | This error occurs when given field is null |
| DEV_060 { #DEV_060 } | 400 | {} cannot be empty - {} | This error occurs when search fields are empty |
| DEV_061 { #DEV_061 } | 409 | Device is already active and cannot be unlocked | This error occurs when we try to unlock an active device |
| DEV_062 { #DEV_062 } | 400 | PublicKey is not configured for the device | This error occurs when public key not configured |
| DEV_063 { #DEV_063 } | 409 | This certificate is already registered for this device | This error occurs when certificate is already registered for this device |
| DEV_064 { #DEV_064 } | 404 | No CA cert with this caCertOrigin was found | This error occurs when CA cert with the specified caCertOrigin does not exist |
| DEV_065 { #DEV_065 } | 500 | Unable to get certificate data for this request | This error occurs when there is an issue fetching certificate data |
| DEV_066 { #DEV_066 } | 500 | Internal Server Error | Internal Server Error |
| DEV_067 { #DEV_067 } | 400 | Invalid value for query param ‘include’. Allowed values: full | This error occurs when invalid value given for query param |
| DEV_068 { #DEV_068 } | 404 | Device not found for id: {} | This error occurs when a device with the specified ID does not exist |
| DEV_069 { #DEV_069 } | 400 | Certificate association with device not found | This error occurs when trying to get the certificateId which is not associated to device |
| DEV_070 { #DEV_070 } | 400 | sku is not valid | This error occurs when the provided sku is not valid |
| DEV_071 { #DEV_071 } | 400 | Device can only update publicKey field | This error occurs when a device tries to update fields other than publicKey |
| DEV_072 { #DEV_072 } | 404 | Device not found for id: {}. {} | This error occurs when a device with the specified ID does not exist in the specified region |
| DEV_073 { #DEV_073 } | 403 | Not authorized to read device transfer history | This error occurs when the user does not have permission to read device transfer history |
| DEV_074 { #DEV_074 } | 400 | Invalid filter query: {} | This error occurs when the filter query violates an RSQL rule or business rule. |
| DEV_075 { #DEV_075 } | 400 | Account {} should be a {} account | This error occurs when a dealer/customer account type mismatch happens while listing devices |
| DEV_076 { #DEV_076 } | 404 | Relationship not found between accounts {} and {} | This error occurs when the specified relationship between the provided accounts does not exist |
| DEV_077 { #DEV_077 } | 404 | Account not found for id: {} | This error occurs when the specified dealer or customer account id does not exist while listing devices |
| DEV_078 { #DEV_078 } | 409 | Application already exists. {} must be unique. | This error occurs create/update application has a combination keys that already exists |
| DEV_079 { #DEV_079 } | 409 | Application Id already exists | This error occurs create application has a id that already exists |
| DEV_080 { #DEV_080 } | 403 | Not authorized to perform create applications | This error occurs when calling subject does not have permission to create applications |
| DEV_101 { #DEV_101 } | 403 | Not authorized to perform update applications | This error occurs when calling subject does not have permission to update applications |
| DEV_102 { #DEV_102 } | 403 | Not authorized to perform read applications | This error occurs when calling subject does not have permission to read applications |
| DEV_103 { #DEV_103 } | 403 | Not authorized to perform delete applications | This error occurs when calling subject does not have permission to delete applications |
| DEV_081 { #DEV_081 } | 404 | Application not found | This error occurs when an application with the specified ID does not exist |
| DEV_082 { #DEV_082 } | 403 | Application association with device not found | This error occurs when association of application could not be found with the specified device |
| DEV_083 { #DEV_083 } | 400 | Device already has {} applications associated | This error occurs when trying to create more than 3 applications for a device |
| DEV_084 { #DEV_084 } | 409 | Device cannot be deleted. Device is associated to applications. | This error occurs when device cannot be deleted because it is associated with applications |
| DEV_132 { #DEV_132 } | 409 | Device cannot be deleted while a transfer is pending or scheduled. | This error occurs when device cannot be deleted because a pending or scheduled transfer exists for the device |
| DEV_085 { #DEV_085 } | 400 | Exception in extracting public key from CSR | This error occurs when publicKey extraction from CSR fails |
| DEV_086 { #DEV_086 } | 400 | CSR signature validation failed | This error occurs when CSR signature validation fails |
| DEV_087 { #DEV_087 } | 400 | Invalid CSR PEM | This error occurs when the CSR PEM given in payload is invalid |
| DEV_088 { #DEV_088 } | 409 | Certificate ID already exists | This error occurs when trying to create a certificate with an ID that already exists |
| DEV_089 { #DEV_089 } | 404 | Certificate not found | This error occurs when attempting to access a certificate that does not exist |
| DEV_090 { #DEV_090 } | 400 | ApplicationId is not valid | This error occurs when given ApplicationId is invalid |
| DEV_091 { #DEV_091 } | 400 | Unsupported entity type | This error occurs when entity type is not supported |
| DEV_092 { #DEV_092 } | 400 | subscriptionScopes cannot be an empty list | This error occurs when create/update application payload has emtpyList subscriptionScopes |
| DEV_093 { #DEV_093 } | 400 | Individual subscriptionScope should be a non empty string | This error occurs when create/update application payload has invalid subscriptionScope value |
| DEV_094 { #DEV_094 } | 400 | Application given in subscriptionScopes not found for : {0} | This error occurs when create/update application payload has subscriptionScope value that does not correspond to any existing application |
| DEV_095 { #DEV_095 } | 400 | Application name update not allowed | This error occurs when there is an attempt to update the application name |
| DEV_096 { #DEV_096 } | 400 | CSR should not be provided when unlockCertRotation is set | This error occurs when there is an attempt to provide a CSR while unlocking the application is set |
| DEV_097 { #DEV_097 } | 400 | Application reached certificate rotation limit. Next certificate rotation can be requested after {0} | This error occurs when application has reached SuccessRotationLock |
| DEV_098 { #DEV_098 } | 400 | Application locked due to exceeding failure certificate rotation limit. Please unlock application or next certificate rotation can be requested after {0} | This error occurs when application has reached FailureRotationLock |
| DEV_099 { #DEV_099 } | 409 | Application is already active and cannot be unlocked | This error occurs when we try to unlock an active Application |
| DEV_100 { #DEV_100 } | 400 | Invalid value for sortBy parameter. Allowed values: model, accounts.current.name | This error occurs when the sort by field is invalid |
| DEV_109 { #DEV_109 } | 409 | Device transfer transaction failed due to a concurrent modification | This error occurs when a transactional write for a device transfer is canceled by DynamoDB |
| DEV_110 { #DEV_110 } | 400 | Invalid startDate format: ‘{}’. Expected format is ‘YYYY-MM-DDTHH:MM:SSZ’ | This error occurs when the startDate field is not in RFC 3339 UTC format with a Z suffix |
| DEV_111 { #DEV_111 } | 500 | Failed to register the transfer schedule. Please try again. | This error occurs when EventBridge Scheduler fails to create the schedule |
| DEV_112 { #DEV_112 } | 409 | Device already has a scheduled transfer | This error occurs when a transfer has already been scheduled for the device |
| DEV_113 { #DEV_113 } | 400 | startDate is not supported for the approval workflow. The caller must have transfer permission on both accounts to schedule a transfer. | This error occurs when startDate is provided but the caller only qualifies for the approval workflow |
| DEV_114 { #DEV_114 } | 404 | No active schedule found for device transfer: {} | This error occurs when the EventBridge schedule for the device transfer no longer exists |
| DEV_115 { #DEV_115 } | 500 | Failed to delete the transfer schedule | This error occurs when EventBridge Scheduler fails to delete the schedule |
| DEV_116 { #DEV_116 } | 400 | startDate must be between {} and {} | This error occurs when the startDate is outside the allowed scheduling window (1–7 days from now) |
| DEV_117 { #DEV_117 } | 400 | Operation not allowed for a blocked device | This error occurs when a mutating operation is attempted on a device with blocked status |
| DEV_118 { #DEV_118 } | 400 | Invalid status value. Allowed values: BLOCKED, ACTIVE | This error occurs when an invalid device status value is provided |
| DEV_119 { #DEV_119 } | 400 | statusMetaData is required when status is provided | This error occurs when status is provided without statusMetaData |
| DEV_120 { #DEV_120 } | 400 | reason is required in statusMetaData | This error occurs when reason is missing in statusMetaData |
| DEV_121 { #DEV_121 } | 400 | comment is required in statusMetaData | This error occurs when comment is missing in statusMetaData |
| DEV_122 { #DEV_122 } | 400 | comment must not exceed 250 characters | This error occurs when comment exceeds the maximum length of 250 characters |
| DEV_123 { #DEV_123 } | 400 | No other fields are allowed when {} is provided | This error occurs when status/statusMetaData is provided along with other update fields |
| DEV_124 { #DEV_124 } | 400 | status is required when statusMetaData is provided | This error occurs when statusMetaData is provided without status |
| DEV_125 { #DEV_125 } | 400 | reason cannot be provided when changing status to ACTIVE | This error occurs when reason is provided while changing status to ACTIVE |
| DEV_126 { #DEV_126 } | 403 | Not authorized to update device status | This error occurs when a user without the update_status permission tries to update status or statusMetaData |
| DEV_127 { #DEV_127 } | 400 | Invalid value for query param ‘fields’. Allowed values: shipmentData | This error occurs when an unsupported value is given for the ‘fields’ query param |
| DEV_128 { #DEV_128 } | 400 | requireApproval=true cannot be combined with startDate; scheduled transfers do not support the approval workflow. | This error occurs when requireApproval=true is set together with startDate |
| DEV_129 { #DEV_129 } | 400 | requireApproval must be either true or false | This error occurs when requireApproval is empty or not a boolean string |
| DEV_130 { #DEV_130 } | 400 | friendlyName must be 100 characters or fewer | This error occurs when friendlyName exceeds the maximum allowed length of 100 characters |
| DEV_131 { #DEV_131 } | 403 | friendlyName can only be set by callers whose account is a dealer or customer | This error occurs when friendlyName is updated by a caller whose token account is not a dealer or customer, or when the device has no committed account relation |
| DEV_133 { #DEV_133 } | 404 | Account not found for desiredAccountId: {} | This error occurs when the desiredAccountId in a device transfer request does not correspond to an existing account |
| DEV_250 { #DEV_250 } | 400 | DPoP proof validation failed | This error occurs when the DPoP proof is invalid (missing/malformed proof, bad signature, htm/htu mismatch, or jti replay) |
| DEV_251 { #DEV_251 } | 401 | DPoP token binding failed | This error occurs when DPoP token binding fails (ath mismatch, cnf.jkt mismatch, or Bearer used with a DPoP-bound token) |
| DEV_701 { #DEV_701 } | 500 | Internal Server Error | Internal Server Error |
| DEV_702 { #DEV_702 } | 500 | Internal Server Error | Internal Server Error |
| DEV_703 { #DEV_703 } | 500 | Internal Server Error | Internal Server Error |
| DEV_704 { #DEV_704 } | 500 | Internal Server Error | Internal Server Error |
| DEV_400 { #DEV_400 } | 400 | Generic message: ‘Spec mismatch error’ | This error occurs when there is a mismatch between the OpenAPI spec and the request submitted. Please verify the request against the spec. If you notice the error is not a spec mismatch raise a support ticket |
| DEV_500 { #DEV_500 } | 500 | Generic message: ‘Internal server error’ | This error occurs due to some internal problem. Immediately raise a support ticket |
| /// |
/// tab | Organizations
| Error code | Http status code | Error message | Description |
|---|---|---|---|
| ORG_001 { #ORG_001 } | 422 | Enrichment error: Invalid or missing country data | This error occurs when the country code in fetched organization data is not available or invalid. |
| ORG_002 { #ORG_002 } | 422 | Enrichment error: Invalid country data {} | This error occurs when the country code in fetched organization data is invalid. |
| ORG_003 { #ORG_003 } | 400 | Organizations hierarchy can not have more than 3 levels | This error occurs when the organization data hierarchy exceeds the threshold. |
| ORG_004 { #ORG_004 } | 404 | Organization not found for id {} | This error occurs when the organization data is not found. |
| ORG_005 { #ORG_005 } | 403 | Organization with id {} not authorized | This error occurs when the Organization is not authorized for user. |
| ORG_006 { #ORG_006 } | 500 | Unexpected error in sending Org details to external enrichment service | This unexpected error occurs when sending the organization details to external enrichment service. |
| ORG_007 { #ORG_007 } | 404 | Resource not found for organization id {} | This error occurs when no resource found for organization hierarchy validation. |
| ORG_008 { #ORG_008 } | 404 | Resource not found for {} id {} | This error occurs when no resource found for organization entity creation. |
| ORG_009 { #ORG_009 } | 409 | Organization with given name or website already exists | This error occurs when organization with given name or website already exists |
| ORG_010 { #ORG_010 } | 404 | Resource not found for account id {} | This error occurs when no resource found while try to fetch account entity. |
| ORG_011 { #ORG_011 } | 403 | Not authorized to perform the operation | This error occurs when entity not accessible or it does not have authorization |
| ORG_012 { #ORG_012 } | 400 | Query param ‘include’ should be ‘full’ or None | This error occurs when provided an invalid value for the query parameter in request |
| ORG_013 { #ORG_013 } | 400 | Id should not be provided in the payload | This error occurs when sending an id field in the (payload), but the system does not allow it. |
| ORG_014 { #ORG_014 } | 409 | Organization with name {} already exists | This error occurs when organisation with given name already exists. |
| ORG_015 { #ORG_015 } | 404 | Account not found for id {} | This error occurs when no account entity found for given id. |
| ORG_016 { #ORG_016 } | 409 | Account with id {} already added to given organization | This error occurs when relation already exist between given account and organization. |
| ORG_017 { #ORG_017 } | 404 | Organization relation not found for account id {} | This error occurs when no org relation found for the given account id. |
| ORG_018 { #ORG_018 } | 400 | Error adding account with id {} to given organization {} | This error occurs when application failed to add the specified account to the organization |
| ORG_019 { #ORG_019 } | 409 | Account {} already related with organization {} | This error occurs when account with the given ID is already linked to the specified organization |
| ORG_020 { #ORG_020 } | 404 | AccountId not found in query params and token | This error occurs when accountId is missing from both the query parameters and the authentication token |
| ORG_021 { #ORG_021 } | 400 | Either ‘name’ or ‘website’ must be provided | At least one of the fields, name or website, is required in the request, This error occurs when both are missing. |
| ORG_022 { #ORG_022 } | 408 | Request timeout, please try again later | This error occurs when the enrichment service request timed out. |
| ORG_023 { #ORG_023 } | 404 | Organization not found for id {}. Please find the data in region: {} | This error occurs when the organization data is not found. |
| ORG_024 { #ORG_024 } | 500 | Internal server error | This error occurs when the transaction is failed due to an unexpected error. |
| ORG_025 { #ORG_025 } | 501 | Adding users to a {} organization type is not currently supported | This error occurs when add user to organization is not supported for the organization’s type (e.g. singleTierHierarchical). |
| ORG_026 { #ORG_026 } | 400 | Invalid or unsupported organization type {} | This error occurs when the organization payload has an unknown type value. |
| ORG_027 { #ORG_027 } | 404 | User not found for id {} | This error occurs when user for the given id is not found |
| ORG_028 { #ORG_028 } | 501 | Removing a user from this organization type is not implemented for organization type {} | This error occurs when remove user from organization is not supported for the organization’s type (e.g. singleTierHierarchical). |
| ORG_029 { #ORG_029 } | 404 | User not present in organization for id {} | This error occurs when the user is not present in the specified organization. |
| ORG_028 { #ORG_028 } | 400 | Account type must be {} account | This error occurs when the account type is not valid. |
| ORG_029 { #ORG_029 } | 404 | Partner of relation not found for organization id {} | This error occurs when the organization partner of relation is not found. |
| ORG_030 { #ORG_030 } | 404 | Doing business with relation not found for account id {} | This error occurs when the account doing business with relation is not found. |
| ORG_031 { #ORG_031 } | 404 | User not part of organization id {} | This error occurs when the user is not part of the organization. |
| ORG_032 { #ORG_032 } | 409 | Account with id {} already part of organization {} | This error occurs when account already part of another organization. |
| ORG_033 { #ORG_033 } | 400 | User id is required to add user to organization | This error occurs when the request body is missing user id. |
| ORG_034 { #ORG_034 } | 404 | User not found for id {} | This error occurs when the user does not exist. |
| ORG_035 { #ORG_035 } | 400 | User without email cannot be added to an organization | This error occurs when the target user has no email address. |
| ORG_036 { #ORG_036 } | 400 | Role ids cannot be empty | This error occurs when role validation receives an empty role list. |
| ORG_037 { #ORG_037 } | 404 | Role id {} not found | This error occurs when a role id does not exist or is not visible to the application. |
| ORG_038 { #ORG_038 } | 404 | Role ids not found {} | This error occurs when multiple role ids are not found. |
| ORG_039 { #ORG_039 } | 403 | Not authorized to access role {} | This error occurs when the application cannot assign the role. |
| ORG_040 { #ORG_040 } | 403 | Role {} is scoped to a different account | This error occurs when a role is account-scoped and does not match the caller account context. |
| ORG_041 { #ORG_041 } | 403 | Role delegation is not allowed for the caller | This error occurs when the caller cannot delegate the requested roles. |
| ORG_042 { #ORG_042 } | 400 | Email templates must include newUserTemplateId and existingUserTemplateId | This error occurs when custom email templates are incomplete. |
| ORG_043 { #ORG_043 } | 400 | Email templates must include variables when specified | This error occurs when custom email templates omit variables. |
| ORG_044 { #ORG_044 } | 409 | User {} is already in {} status in organization {} | This error occurs when attempting to add a user with an existing organization membership status. |
| ORG_045 { #ORG_045 } | 404 | User not part of account id {} | This error occurs when the user is not part of the account. |
| ORG_046 { #ORG_046 } | 400 | Account with id {} is not a dealer account | This error occurs when the account is not a dealer account. |
| ORG_047 { #ORG_047 } | 404 | Default account not found for organization {} | This error occurs when a user without a default account is added to a customer STNH organization that has no unique default account relation. |
| ORG_048 { #ORG_048 } | 409 | Cannot remove the default account {} from the organization; A single-tier non-hierarchical organization must retain one default account | This error occurs when attempting to remove the organization’s default account. |
| ORG_049 { #ORG_049 } | 501 | Removing an account from a {} organization type is not currently supported | This error occurs when remove account from organization is not supported for the organization’s type (temporary STNH block until cascade teardown is ready). |
| ORG_250 { #ORG_250 } | 400 | DPoP proof validation failed | This error occurs when the DPoP proof is invalid (missing/malformed proof, bad signature, htm/htu mismatch, or jti replay) |
| ORG_251 { #ORG_251 } | 401 | DPoP token binding failed | This error occurs when DPoP token binding fails (ath mismatch, cnf.jkt mismatch, or Bearer used with a DPoP-bound token) |
| ORG_400 { #ORG_400 } | 400 | Generic message: ‘Spec mismatch error’ | This error occurs when there is a mismatch between the OpenAPI spec and the request submitted. Please verify the request against the spec. If you notice the error is not a spec mismatch raise a support ticket |
| ORG_500 { #ORG_500 } | 500 | Generic message: ‘Internal server error’ | This error occurs due to some internal problem. Immediately raise a support ticket |
| /// |
/// tab | Roles
| Error code | Http status code | Error message | Description |
|---|---|---|---|
| ROL_001 { #ROL_001 } | 400 | A maximum limit of {} reached for the calling application and account | This error occurs when the number of roles for the application has reached the configured maximum limit during role creation |
| ROL_002 { #ROL_002 } | 400 | A maximum limit of {} reached for the calling application | This error occurs when the number of permissions for the application has reached the configured maximum limit during permission creation |
| ROL_003 { #ROL_003 } | 403 | Calling application does not have access to the requested permission | This error occurs when the calling application tries to access a permission that it is not authorized to use during permission retrieval |
| ROL_004 { #ROL_004 } | 403 | Calling application does not have access to the requested application permissions | This error occurs when the calling application tries to access permissions of another application during permissions retrieval |
| ROL_005 { #ROL_005 } | 400 | Query param ‘on’ or ‘object’ is required | This error occurs when the ‘on’ or ‘object’ parameter is not provided in the request to check if a permission is allowed on a specific object |
| ROL_006 { #ROL_006 } | 400 | Query param ‘subject’ is required | This error occurs when the ‘subject’ parameter is not provided in the request to check if a permission is allowed for a specific object |
| ROL_007 { #ROL_007 } | 403 | Permission with id {} does not belong to the application {} | This error occurs when an application tries to update the permission of another application |
| ROL_008 { #ROL_008 } | 500 | Failed to get shared roles | This error occurs when there is an internal issue retrieving roles. Raise a ticket to the support team |
| ROL_009 { #ROL_009 } | 404 | {} not found for ID {} | This error occurs when the specified entity is not found in the system |
| ROL_010 { #ROL_010 } | 404 | Permissions not found {} | This error occurs when the permissions are not found when trying to created a role or update a permission |
| ROL_011 { #ROL_011 } | 404 | Permissions not found for this application ID {} | This error occurs when no permissions are found for the specified application ID |
| ROL_012 { #ROL_012 } | 500 | Failed to create role | This error occurs when there is an internal issue creating a role. Raise a ticket to the support team |
| ROL_013 { #ROL_013 } | 409 | Role with ID {} already exists | This error occurs when trying to create a role with an ID that already exists in the system |
| ROL_014 { #ROL_014 } | 409 | Role with name {} already exists under application {} | This error occurs when trying to create or update a role with a name that already exists under the specified application |
| ROL_015 { #ROL_015 } | 404 | Role with ID {} not found | This error occurs when trying to access a role that does not exist in the system |
| ROL_016 { #ROL_016 } | 403 | Role {} is scoped to a different account | This error occurs when trying to access a role that is scoped to a different account than the callers account |
| ROL_017 { #ROL_017 } | 404 | Role {} is scoped to account but no account is configured | This error occurs when role detail does not have an account configured. Raise a ticket to the support team |
| ROL_018 { #ROL_018 } | 403 | Calling application not authorized to access role {} | This error occurs when the calling application does not have permission to access the specified role |
| ROL_019 { #ROL_019 } | 404 | Group {} not found | This error occurs when the group with the specified ID is not found in the system |
| ROL_020 { #ROL_020 } | 404 | User with ID {} not found | This error occurs when the user with the specified ID is not found in the system |
| ROL_021 { #ROL_021 } | 404 | Permission not found for ID {} | This error occurs when the permission with the specified ID is not found in the system |
| ROL_022 { #ROL_022 } | 400 | Duplicate {} IDs found, duplicate IDs {} | This error occurs when trying to create or update role with duplicate permission IDs in the request |
| ROL_023 { #ROL_023 } | 400 | Only application, account and group trn is supported in ‘on’ parameter | This error occurs when the ‘on’ parameter in the request is not supported |
| ROL_024 { #ROL_024 } | 403 | User token is not supported | This error occurs when the user token is not supported for the requested operation |
| ROL_025 { #ROL_025 } | 400 | Invalid {} ID | This error occurs when the provided ID is not in UUID format |
| ROL_026 { #ROL_026 } | 400 | Payload is not valid JSON | This error occurs when the payload provided in the request is not valid JSON format |
| ROL_027 { #ROL_027 } | 400 | Empty payload not allowed | This error occurs when the request payload is empty, which is not allowed for the operation |
| ROL_028 { #ROL_028 } | 403 | Calling application does not have access to the requested application roles | This error occurs when the calling application does not have permission to access roles of another application |
| ROL_029 { #ROL_029 } | 404 | Role ID {} does not exists for application ID {} | This error occurs when there is no relation between the specified role ID and application ID |
| ROL_030 { #ROL_030 } | 404 | Roles not found for application ID {} | This error occurs when no roles are found for the specified application ID |
| ROL_031 { #ROL_031 } | 400 | Only account trn, application trn, group trn is supported in ‘on’ parameter | This error occurs when the ‘on’ parameter in the request is not supported |
| ROL_032 { #ROL_032 } | 400 | Only account trn, application trn is supported in ‘on’ parameter | This error occurs when the ‘on’ parameter in the request is not supported |
| ROL_033 { #ROL_033 } | 404 | No relation exists between application {} and account {} | This error occurs when there is no relation between the specified application and account |
| ROL_034 { #ROL_034 } | 409 | Role ID {} already assigned | This error occurs when trying to assign a role that is already assigned to the specified entity |
| ROL_035 { #ROL_035 } | 404 | Role ID {} is not assigned | This error occurs when trying to update or delete a role that is not assigned to the specified entity |
| ROL_036 { #ROL_036 } | 400 | Invalid trn {} | This error occurs when the provided trn is not valid |
| ROL_037 { #ROL_037 } | 409 | Permission with ID {} already exists | This error occurs when trying to create a permission with an ID that already exists in the system |
| ROL_038 { #ROL_038 } | 409 | Permission already exists under application {} | This error occurs when trying to update a permission that already exists under the specified application |
| ROL_039 { #ROL_039 } | 400 | No account ID found in the group payload | This error occurs when the group payload does not contain an account ID, which is required for the operation. Raise a ticket to the support team |
| ROL_040 { #ROL_040 } | 400 | Account ID in on parameter does not match with Group’s account ID | This error occurs when the account ID provided in the ‘on’ parameter does not match with the account ID of the group |
| ROL_041 { #ROL_041 } | 400 | Only account trn, group trn is supported in ‘on’ parameter | This error occurs when the ‘on’ parameter in the request is not supported when trying to list roles for a device |
| ROL_042 { #ROL_042 } | 404 | Role cannot be assigned to the same application | This error occurs when trying to assign a role to the same calling application |
| ROL_043 { #ROL_043 } | 403 | Calling application is not the owner of group ID {} | This error occurs when the calling application tries to access a group that it does not own |
| ROL_044 { #ROL_044 } | 409 | Permission with same action and resource already exists under application ID {} | This error occurs when trying to create a permission with the same action and resource |
| ROL_045 { #ROL_045 } | 404 | No relation exists between group ID {} and account ID {} | This error occurs when there is no relation between the specified group and account |
| ROL_046 { #ROL_046 } | 404 | No relation exists between group ID {} and application ID {} | This error occurs when there is no relation between the specified group and application |
| ROL_047 { #ROL_047 } | 404 | No relation exists between device ID {} and account ID {} | This error occurs when there is no relation between the specified device and account |
| ROL_048 { #ROL_048 } | 404 | No relation exists between user ID {} and account ID {} | This error occurs when there is no relation between the specified user and account |
| ROL_049 { #ROL_049 } | 400 | Account id is missing in the request | This error occurs when the request does not contain an account ID, which is required for the operation |
| ROL_050 { #ROL_050 } | 404 | No applications found for the role ID {} | This error occurs when trying to find applications associated with a role ID that does not exist |
| ROL_051 { #ROL_051 } | 403 | Not authorized to perform this operation | This error occurs when the caller is not the approver group |
| ROL_052 { #ROL_052 } | 404 | Application not found for ID {} | This error occurs when the application with the specified ID is not found in the system |
| ROL_053 { #ROL_053 } | 403 | Application has trust by relations but requested {} is not shared {} | This error occurs when the application has trust relations but the requested entity is not shared with it |
| ROL_054 { #ROL_054 } | 400 | Role ID {} is scoped to account & cannot be assigned to application | This error occurs when attempting to assign a user created role to an application or a group |
| ROL_055 { #ROL_055 } | 503 | Unable to get permissions for application {} | Internal error occurred while trying to retrieve permissions. Raise a ticket to the support team |
| ROL_056 { #ROL_056 } | 403 | Application not authorized to use permission IDs {} | This error occurs when the calling application does not have permission to use the specified permission IDs |
| ROL_057 { #ROL_057 } | 403 | Calling application not authorized to access permission ID {} | This error occurs when the calling application does not have permission to access the specified permission ID |
| ROL_058 { #ROL_058 } | 403 | Role with ID {} does not belong to the application ID {} | This error occurs when an application tries to access a role that does not belong to it |
| ROL_059 { #ROL_059 } | 403 | Role with ID {} does not belong to the account ID {} | This error occurs when the calling user tries to update a role that does not belong to the specified account |
| ROL_060 { #ROL_060 } | 500 | Failed to get shared permissions | An internal issue has occurred when retrieving permissions. Raise a ticket to the support team |
| ROL_061 { #ROL_061 } | 500 | Failed while fetching roles for device ID {} | An internal issue has occurred while fetching roles for the device. Raise a ticket to the support team |
| ROL_062 { #ROL_062 } | 500 | Failed to get role ID {} | An internal issue has occurred while fetching the role. Raise a ticket to the support team |
| ROL_063 { #ROL_063 } | 500 | Failed to create permission | An internal issue has occurred while creating the permission. Raise a ticket to the support team |
| ROL_064 { #ROL_064 } | 500 | Failed while fetching roles for user ID {} | An internal issue has occurred while fetching roles for the user. Raise a ticket to the support team |
| ROL_065 { #ROL_065 } | 500 | Failed while fetching roles for application ID {} | An internal issue has occurred while fetching roles for the application. Raise a ticket to the support team |
| ROL_066 { #ROL_066 } | 500 | Failed to update role ID {} | An internal issue has occurred while updating the role. Raise a ticket to the support team |
| ROL_067 { #ROL_067 } | 404 | {} ID {} on query parameter not found | This error occurs when the specified ID in the query parameter is not found in the system |
| ROL_068 { #ROL_068 } | 404 | Device not found for ID {} | This error occurs when the device with the specified ID is not found in the system |
| ROL_069 { #ROL_069 } | 404 | Account not found for ID {} | This error occurs when the account with the specified ID is not found in the system |
| ROL_070 { #ROL_070 } | 404 | No roles found for the device ID {} in the group ID {} using application ID {} | This error occurs when no roles are found for the specified device in the group using the application |
| ROL_071 { #ROL_071 } | 404 | No roles of the application ID {} is assigned to the application ID {} | This error occurs when no roles are assigned between the specified applications |
| ROL_072 { #ROL_072 } | 404 | No roles found for the application ID {} in the group ID {} | This error occurs when no roles are found for the specified application in the group |
| ROL_073 { #ROL_073 } | 404 | No roles of the application ID {} is assigned to the user ID {} | This error occurs when no roles are assigned between the specified application and user |
| ROL_074 { #ROL_074 } | 404 | Resource not found for ID {} | This error occurs when the resource with the specified ID is not found in the system |
| ROL_075 { #ROL_075 } | 400 | Invalid entity type {} for application role assignment | This error occurs when the entity type provided for application role assignment is not supported |
| ROL_076 { #ROL_076 } | 403 | Permissions can only be deleted by their creator | This error occurs when trying to delete a permission that was not created by the calling application |
| ROL_077 { #ROL_077 } | 409 | Cannot delete a permission that is in use | This error occurs when trying to delete a permission that is currently in use by roles |
| ROL_078 { #ROL_078 } | 404 | No roles found for the user ID {} in the group ID {} using application ID {} | This error occurs when no roles are found for the specified user in the group using the application |
| ROL_079 { #ROL_079 } | 404 | No trust relation found for group {} | This error occurs when there is no trust relation between the group and the calling application |
| ROL_080 { #ROL_080 } | 400 | Only account, application, user and group trn are supported in ‘object’ parameter | This error occurs when trying to call check permission endpoint where the given ‘object’ parameter is not supported |
| ROL_081 { #ROL_081 } | 400 | Only user and application trn are supported in ‘subject’ parameter | This error occurs when trying to call check permission endpoint where the ‘subject’ parameter supported are user and application |
| ROL_082 { #ROL_082 } | 404 | Role ID {} does not exists | This error occurs when the specified role ID does not exist in the system |
| ROL_083 { #ROL_083 } | 404 | Role IDs {} does not exists | This error occurs when the given role IDs do not exist in the system |
| ROL_084 { #ROL_084 } | 404 | No relation found between user {} and entity {} | This error occurs when there is no relation between the user and the specified entity |
| ROL_085 { #ROL_085 } | 400 | Cannot remove user’s last role from default account | This error occurs when trying to remove the last role of a user from the default account, which is not allowed. |
| ROL_086 { #ROL_086 } | 404 | Role ID not exists for user {} in entity {} | This error occurs when trying to unassign a role that does not exist for the user in the specified entity |
| ROL_087 { #ROL_087 } | 409 | Role ID already exists for user {} in entity {} | This error occurs when trying to assign a role that already exists for the user in the specified entity |
| ROL_088 { #ROL_088 } | 400 | Invalid entity type {} for user role assignment | This error occurs when the entity type provided for user role assignment is not supported |
| ROL_089 { #ROL_089 } | 403 | Not authorized to access other application role {} | This error occurs when the caller does not have permission to access a role that belongs to another application |
| ROL_090 { #ROL_090 } | 400 | Invalid entity type {} for user role deletion | This error occurs when the entity type provided for user role deletion is not supported |
| ROL_091 { #ROL_091 } | 403 | User does not have permission to assign/unassign role | |
| ROL_092 { #ROL_092 } | 403 | Not authorized to assign/unassign roles to an application | |
| ROL_093 { #ROL_093 } | 403 | Not authorized to assign roles to user | This error occurs when the caller does not have permission to assign roles to a user |
| ROL_094 { #ROL_094 } | 403 | Not authorized to unassign roles to user | This error occurs when the when caller does not have permission to unassign roles from a user |
| ROL_095 { #ROL_095 } | 404 | Relation not found for application {} and {} {} | This error indicates that there is no relation between the application and the target entity |
| ROL_096 { #ROL_096 } | 403 | Not authorized to perform this operation | This error occurs when the caller does not have permission to perform the requested operation |
| ROL_097 { #ROL_097 } | 400 | Only boolean values support in ‘createGroupOnAssignment’ query parameter | This error occurs when the ‘on’ or ‘object’ parameter is not provided in the request to check if a permission is allowed on a specific object |
| ROL_098 { #ROL_098 } | 500 | Internal server error | An internal issue has occurred while transaction write operation |
| ROL_099 { #ROL_099 } | 400 | Invalid entity type {} for device role assignment | This error occurs when the entity type provided for device role assignment is not supported |
| ROL_100 { #ROL_100 } | 403 | Not authorized to unassign roles from device | This error occurs when the caller does not have permission to unassign roles from a device |
| ROL_101 { #ROL_101 } | 404 | Role ID {} is not assigned to device: {} in entity: {} | This error occurs when trying to unassign a role that is not assigned to the specified device in the entity |
| ROL_102 { #ROL_102 } | 400 | Invalid entity type {} for device role deletion | This error occurs when the entity type provided for device role deletion is not supported |
| ROL_103 { #ROL_103 } | 404 | No relation exists between entity ID {} and group ID {} | This error occurs when there is no relation between the specified entity and group |
| ROL_104 { #ROL_104 } | 400 | Cannot remove user’s default role | This error occurs when attempting to remove the default role from a user, which is not allowed. |
| ROL_105 { #ROL_105 } | 400 | Owner role cannot be assigned to devices | This error occurs when attempting to assign the Owner role to a device on any entity |
| ROL_106 { #ROL_106 } | 400 | Role cannot be shared with the application that owns it | This error occurs when attempting to assign the role to a same application that owns it |
| ROL_107 { #ROL_107 } | 403 | Not authorized to assign roles to device | This error occurs when the caller does not have permission to assign roles to a device |
| ROL_108 { #ROL_108 } | 404 | No relation found between device: {} and entity: {} | This error occurs when there is no relation between the device and the specified entity |
| ROL_109 { #ROL_109 } | 409 | roleId already exists for device: {} in entity: {} | This error occurs when trying to assign a role that already exists for the specified device in the entity |
| ROL_110 { #ROL_110 } | 400 | roleIds is required to update device role assignment | This error occurs when roleIds is missing, empty, or not a list when updating device roles |
| ROL_250 { #ROL_250 } | 400 | DPoP proof validation failed | This error occurs when the DPoP proof is invalid (missing/malformed proof, bad signature, htm/htu mismatch, or jti replay) |
| ROL_251 { #ROL_251 } | 401 | DPoP token binding failed | This error occurs when DPoP token binding fails (ath mismatch, cnf.jkt mismatch, or Bearer used with a DPoP-bound token) |
| ROL_400 { #ROL_400 } | 400 | Generic message: ‘Spec mismatch error’ | This error occurs when there is a mismatch between the OpenAPI spec and the request submitted. Please verify the request against the spec. If you notice the error is not a spec mismatch raise a support ticket |
| ROL_500 { #ROL_500 } | 500 | Generic message: ‘Internal server error’ | This error occurs due to some internal problem. Immediately raise a support ticket |
| /// |
/// tab | Users
| Error code | Http status code | Error message | Description |
|---|---|---|---|
| USR_001 { #USR_001 } | 400 | Expiry days should be between 1 and 60 | This error occurs when the provided expiry days for user invite are outside the valid range of 1 to 60 |
| USR_002 { #USR_002 } | 400 | Metadata must contain createdBy, updatedBy, createdAt, updatedAt fields | This error occurs when the metadata is missing one or more required fields |
| USR_003 { #USR_003 } | 400 | {} cannot be empty | This error occurs when one or more required fields in the metadata are empty |
| USR_004 { #USR_004 } | 400 | firstName cannot be empty or None | This error occurs when the firstName field is either empty or not provided in the request |
| USR_005 { #USR_005 } | 400 | lastName cannot be empty or None | This error occurs when the lastName field is either empty or not provided in the request |
| USR_006 { #USR_006 } | 400 | emailTemplates must contain newUserTemplateId and existingUserTemplateId | This error occurs when the emailTemplates field is missing required template IDs |
| USR_007 { #USR_007 } | 400 | emailTemplates must contain variables | This error occurs when the emailTemplates field is missing the required variables field |
| USR_008 { #USR_008 } | 400 | The provided email does not contain an ‘@’ symbol | This error occurs when the email does not contain an ‘@’ symbol |
| USR_009 { #USR_009 } | 400 | The user part or domain part of the given email is invalid | This error occurs when the email’s user part or domain part does not match the expected regex pattern |
| USR_010 { #USR_010 } | 400 | Invalid Country Code ‘{}’ | This error occurs when the country code is not in the list of valid countries |
| USR_011 { #USR_011 } | 400 | Restricted Country Code ‘{}’ | This error occurs when the provided country is in the list of restricted countries |
| USR_012 { #USR_012 } | 400 | State cannot be empty or whitespace | This error occurs when the state field is empty or contains only whitespace |
| USR_013 { #USR_013 } | 400 | Invalid State/Province Code: ‘{}’. Expected a valid ISO-3166 alpha 2 format [e.g. ‘US-AL’] | This error occurs when the state field does not follow the ISO-3166 alpha 2 format |
| USR_014 { #USR_014 } | 400 | Invalid State/Province Code ‘{}’ | This error occurs when the state field is not in valid format |
| USR_015 { #USR_015 } | 400 | Invalid Language Code ‘{}’ | This error occurs when the provided language is not in the supported language list |
| USR_016 { #USR_016 } | 400 | Invalid Timezone Code ‘{}’ | This error occurs when the timezone field contains a value that is not in the list of valid timezones |
| USR_017 { #USR_017 } | 400 | metadata, status, dataRegion, picture, hasPicture and defaultAccount are reserved fields | This error occurs when the payload contains the restricted field ‘metadata’, which is not allowed |
| USR_018 { #USR_018 } | 400 | State/Province must be provided when country is US/CA | This error occurs when the state or province field is missing while the country is US or CA |
| USR_019 { #USR_019 } | 400 | State/Province is applicable only for countries - US and CA | This error occurs when the state or province field is provided for countries other than US or CA |
| USR_020 { #USR_020 } | 400 | Country must be provided when state is present | This error occurs when the state field is provided without specifying the country |
| USR_021 { #USR_021 } | 400 | Both email and userName cannot be provided | This error occurs when both ‘userName’ and ‘email’ fields are provided in the payload, which is not allowed |
| USR_022 { #USR_022 } | 400 | Email and tempPassword cannot be provided together | This error occurs when both ‘email’ and ‘tempPassword’ fields are provided in the payload, which is not allowed |
| USR_023 { #USR_023 } | 400 | userName and tempPassword are required for managed user identification | This error occurs when either ‘userName’ or ‘tempPassword’ is missing |
| USR_024 { #USR_024 } | 400 | Either email or userName is required for user identification | This error occurs when neither ‘userName’ nor ‘email’ fields are provided in the payload |
| USR_025 { #USR_025 } | 400 | The ‘lastLoginTimeStamp’ field cannot be null | This error occurs when the ‘lastLoginTimeStamp’ field is not provided in the payload |
| USR_026 { #USR_026 } | 400 | The ‘lastLoginTimeStamp’ field cannot be empty or whitespace | This error occurs when the ‘lastLoginTimeStamp’ field is provided as an empty or whitespace-only string |
| USR_027 { #USR_027 } | 400 | Invalid lastLoginAt format: ‘{}’. Expected format is ‘YYYY-MM-DDTHH:MM:SSZ’ or ‘YYYY-MM-DDTHH:MM:SS+HH:MM’ | This error occurs when the ‘lastLoginAt’ field is not in the correct ISO 8601 format with a time zone designator or offset |
| USR_028 { #USR_028 } | 400 | {} fields are mandatory | This error occurs when one or more mandatory fields are not provided in the payload |
| USR_029 { #USR_029 } | 409 | User with ID {} already exists | This error occurs when a user with the specified ID already exists in the system when trying to create user |
| USR_030 { #USR_030 } | 409 | User with ID {} already exists | This error occurs when a user with the specified ID already exists in the system when TiD tries to create user |
| USR_031 { #USR_031 } | 400 | A user initially created without an userName or tempPassword cannot be updated to include an userName or tempPassword | This error occurs when attempting to update a user with either ‘userName’ or ‘tempPassword’ who was initially created without these fields |
| USR_032 { #USR_032 } | 400 | A user initially created without an email address cannot be updated to include an email address | This error occurs when attempting to update a user who was initially created without an email address to include one |
| USR_033 { #USR_033 } | 403 | Application token is not allowed to access user information | This error occurs when an application token is used to call users/me endpoint |
| USR_034 { #USR_034 } | 400 | Invalid picture size specified. Allowed values are: {} | This error occurs when the provided picture size is not among the allowed values |
| USR_035 { #USR_035 } | 404 | User not found for the email: {} | This error occurs when no user is found for the specified email address |
| USR_036 { #USR_036 } | 400 | A short code needs to be configured for the account to allow the creation of users without an email address | This error occurs when attempting to create a user without an email address, but the account does not have a short code configured |
| USR_037 { #USR_037 } | 400 | Cannot update when user is in pending state | This error occurs when attempting to update a user who is in a pending state |
| USR_038 { #USR_038 } | 204 | No application roles found | This error occurs when no roles are found for the specified application |
| USR_039 { #USR_039 } | 409 | RoleId already exists for user: {} in account: {} | This error occurs when attempting to add a role to a user in an account, but the role already exists |
| USR_040 { #USR_040 } | 404 | User {} does not exist | This error occurs when the specified user ID does not correspond to any existing user |
| USR_041 { #USR_041 } | 404 | No relation exists between user {} and account {} | This error occurs when trying to add a role to a user in an account, but no relation exists between the user and the account |
| USR_042 { #USR_042 } | 404 | User {} does not exist | This error occurs when the specified user does not exist in the given account when trying to remove a role |
| USR_043 { #USR_043 } | 404 | No relation exists between user {} and account {} | This error occurs when attempting to remove role between user-account relationship and that does not exist |
| USR_044 { #USR_044 } | 400 | A user without an email address cannot be associated with multiple accounts | This error occurs when attempting to associate a managed user to an account |
| USR_045 { #USR_045 } | 403 | Cannot remove MANAGED user from its default account {} | This error occurs when attempting to remove a managed user from their default account, which is not allowed |
| USR_046 { #USR_046 } | 404 | User {} does not exist | This error occurs when the specified user does not exist when trying to delete a user from an account |
| USR_047 { #USR_047 } | 404 | Account {} does not exist | This error occurs when the specified account id does not exist when trying to delete a user from an account |
| USR_048 { #USR_048 } | 404 | No relation exists between user {} and account {} | This error occurs when no relation exists between the user and the account when trying to delete a user from an account |
| USR_049 { #USR_049 } | 400 | User already exists in PENDING status | This error occurs when attempting to add a user to an account, but the user already exists in a PENDING status |
| USR_050 { #USR_050 } | 409 | User already exists | This error occurs when attempting to create or add a user who already exists in the system |
| USR_051 { #USR_051 } | 404 | Account {} does not exist | This error occurs when the specified account id does not exist in the system when trying to patch user to account relation |
| USR_052 { #USR_052 } | 404 | User {} does not exist | This error occurs when the specified user id does not exist in the system when trying to patch user to account relation |
| USR_053 { #USR_053 } | 404 | Account not found for id: {} | This error occurs when the specified account id does not exist in the system when trying to patch user to account relation |
| USR_054 { #USR_054 } | 400 | Default account cannot be removed | This error occurs when attempting to remove the default account from a user when patching user to account relation, which is not allowed |
| USR_055 { #USR_055 } | 404 | No relation exists between user {} and account {} | This error occurs when attempting to access or modify a relationship between a user and an account that does not exist |
| USR_056 { #USR_056 } | 404 | User not found for id: {} | This error occurs when the specified user does not exist in the system when trying to update user picture |
| USR_057 { #USR_057 } | 404 | User not found for id: {} | This error occurs when the specified user not found when trying to add to an account |
| USR_058 { #USR_058 } | 400 | ‘file’ key is missing in the request | This error occurs when the ‘file’ key is not present in the request payload. |
| USR_059 { #USR_059 } | 400 | Image File not Found | This error occurs when the image file is missing in the request. |
| USR_060 { #USR_060 } | 415 | Content-Type: {} not supported | This error occurs when the provided Content-Type is not supported by the application. |
| USR_061 { #USR_061 } | 400 | Picture media type: {} not supported | This error occurs when the provided picture media type is not supported |
| USR_062 { #USR_062 } | 400 | ‘file’ key is missing in the request | This error occurs when the ‘file’ key is not present in the request payload |
| USR_063 { #USR_063 } | 400 | invalid picture data | This error occurs when the provided picture data is invalid or cannot be processed |
| USR_064 { #USR_064 } | 400 | Picture media type: {} not supported | This error occurs when the provided picture media type is not supported when data is decoded as binary data |
| USR_065 { #USR_065 } | 400 | Invalid picture data provided | This error occurs when the provided picture data is invalid or cannot be processed |
| USR_066 { #USR_066 } | 400 | Picture width or height is less than the minimum allowed dimensions: width: {} / height: {} | This error occurs when the uploaded picture’s dimensions are smaller than the required minimum dimensions |
| USR_067 { #USR_067 } | 400 | The image has {} content. | This error occurs when the uploaded image contains unsafe content as detected by the system |
| USR_068 { #USR_068 } | 400 | Picture size exceeded max size: {} MB | This error occurs when the uploaded picture’s size exceeds the maximum allowed size |
| USR_069 { #USR_069 } | 400 | invalid picture data | This error occurs when the provided image data cannot be opened or is in an unsupported format |
| USR_070 { #USR_070 } | 415 | Content-Type must be {} | This error occurs when the provided content-type is not supported when trying to patch user to account relation |
| USR_071 { #USR_071 } | 400 | roleIds is required to update user account relation | This error occurs when the roleIds field is missing in the request to update a user account relation |
| USR_072 { #USR_072 } | 400 | default is required to update user account relation | This error occurs when the ‘default’ flag is missing in the request to update a user account relation |
| USR_073 { #USR_073 } | 404 | Account not found for id: {} | This error occurs when the specified account id does not exist when trying to list users |
| USR_074 { #USR_074 } | 400 | Invalid filter query | This error occurs when the provided filter query is not valid when trying to list users |
| USR_075 { #USR_075 } | 404 | User not found for id: {} | This error occurs when the specified user id does not exist when trying to list accounts of a user |
| USR_076 { #USR_076 } | 400 | Invalid filter query | This error occurs when the provided filter query is not valid when trying to list accounts of a user |
| USR_077 { #USR_077 } | 404 | User not found for id: {} | This error occurs when the specified user id does not exist when trying to list groups of a user |
| USR_078 { #USR_078 } | 404 | User not found for id: {} | This error occurs when the specified user id does not exist in the system. |
| USR_078 { #USR_078 } | 404 | Account {} does not exist | This error occurs when the specified account id does not exist when trying to assign a role to a user in an account |
| USR_080 { #USR_080 } | 404 | Account {} does not exist | This error occurs when the specified account id does not exist in the system |
| USR_081 { #USR_081 } | 400 | Cannot remove user’s last role from default account | This error occurs when attempting to remove the last role from a user’s default account, which is not allowed |
| USR_082 { #USR_082 } | 400 | roleId {} not found for user {} in account {} | This error occurs when the specified role id is not associated with the user in the given account |
| USR_083 { #USR_083 } | 400 | Cannot remove user’s default role | This error occurs when attempting to remove the default role from a user, which is not allowed. |
| USR_084 { #USR_084 } | 404 | Account {} does not exist | This error occurs when the specified account id does not exist when trying to update user account relation |
| USR_085 { #USR_085 } | 404 | User {} does not exist | This error occurs when the specified user id does not exist when trying to update user account relation |
| USR_086 { #USR_086 } | 404 | roleIds {} do not exist | This error occurs when the specified role id does not exist when trying to update user account relation |
| USR_087 { #USR_087 } | 400 | Default account cannot be removed | This error occurs when attempting to remove the default account from a user when updating user account relation, which is not allowed |
| USR_088 { #USR_088 } | 404 | No relation exists between user {} and account {} | This error occurs when there is no existing relationship between the specified user and account when trying to update user account relation |
| USR_089 { #USR_089 } | 400 | User already exists in PENDING status | This error occurs when attempting to create a user that already exists in a PENDING status |
| USR_090 { #USR_090 } | 409 | User already exists | This error occurs when attempting to create a user that already exists in the system |
| USR_091 { #USR_091 } | 404 | Account {} does not exist | This error occurs when the specified account id does not exist when trying to create a user |
| USR_092 { #USR_092 } | 400 | metadata, status, dataRegion, picture, hasPicture and defaultAccount are reserved fields | This error occurs when the payload contains fields that are restricted and cannot be modified when creating and updating a user |
| USR_093 { #USR_093 } | 400 | Field ‘id’ is required | This error occurs when the ‘id’ field is missing in the request payload during user addition to an account |
| USR_094 { #USR_094 } | 404 | Account {} does not exist | This error occurs when the specified account id does not exist in the system when trying to add a user to an account |
| USR_095 { #USR_095 } | 404 | Account {} does not exist | This error occurs when the specified account id does not exist when trying to list users in an account |
| USR_096 { #USR_096 } | 404 | Account {} does not exist | This error occurs when the specified account id does not exist when trying to remove a user from an account |
| USR_097 { #USR_097 } | 404 | Picture does not exist | This error occurs when the requested picture for the user does not exist when trying to delete user picture |
| USR_098 { #USR_098 } | 404 | User not found for id: {} | This error occurs when the specified user id does not exist when trying to delete user picture |
| USR_099 { #USR_099 } | 404 | Given roles are empty | This error occurs when the specified roles are empty or not provided in the request |
| USR_100 { #USR_100 } | 404 | RoleId {} does not exist | This error occurs when the specified role id does not exist |
| USR_101 { #USR_101 } | 404 | RoleIds {} does not exist | This error occurs when the specified role ids does not exist |
| USR_102 { #USR_102 } | 403 | Role {} is scoped to a different account | This error occurs when the specified role is scoped to an account different from the one being accessed |
| USR_103 { #USR_103 } | 403 | Not authorized to access other application role {} | This error occurs when attempting to access a role belonging to a different application without proper authorization |
| USR_104 { #USR_104 } | 404 | User not found for id: {} | This error occurs when the specified user id does not exist when TiD tries to update a user |
| USR_105 { #USR_105 } | 409 | User with {} already exist | This error occurs when TiD attempts to update a user with a field value that already exists in the system |
| USR_106 { #USR_106 } | 400 | Invalid Country and State combination. State code should match with Country: {} | This error occurs when the provided state code does not match the specified country |
| USR_107 { #USR_107 } | 404 | User not found for email: {} | This error occurs when no user is found with the specified email address |
| USR_108 { #USR_108 } | 404 | User not found for email: {} | This error occurs when no user is found with the specified email address in any page |
| USR_109 { #USR_109 } | 400 | User invitation must be in the pending state to perform this operation | This error occurs when attempting to perform an operation on a user invitation that is not in the pending state. |
| USR_110 { #USR_110 } | 400 | Invitation does not exist for the email: {} | This error occurs when attempting to access or modify an invitation that does not exist for the specified email |
| USR_111 { #USR_111 } | 404 | Relation does not exist between the user {} and the account {} | This error occurs when attempting to access or modify a relation that does not exist between the specified user and account |
| USR_112 { #USR_112 } | 404 | Account not found for id: {} | This error occurs when attempting to resend an invitation, but the specified account does not exist |
| USR_113 { #USR_113 } | 404 | Account not found for id: {} | This error occurs when attempting to cancel an invitation, but the specified account does not exist |
| USR_114 { #USR_114 } | 404 | User not found for id: {} | This error occurs when attempting to update a user, but the specified user does not exist |
| USR_115 { #USR_115 } | 409 | User with {} already exists | This error occurs when attempting to update a user with a field value that already exists in the system |
| USR_116 { #USR_116 } | 404 | User not found for id: {} | This error occurs when TiD attempts to patch a user, but the specified user does not exist |
| USR_117 { #USR_117 } | 409 | User with {} already exists | This error occurs when TiD attempts to patch a user with a field value that already exists in the system |
| USR_118 { #USR_118 } | 403 | Not authorized to perform the search operation | This error occurs when a user attempts to search for another user without the necessary permissions |
| USR_119 { #USR_119 } | 404 | User not found for email: {} | This error occurs when attempting to search for a user by email, but no user exists with the specified email address |
| USR_120 { #USR_120 } | 404 | Resource not found for id: {} | This error occurs when attempting to access a resource that does not exist for the specified id |
| USR_121 { #USR_121 } | 404 | {} | This error occurs when TiD attempts to create a user |
| USR_122 { #USR_122 } | 404 | User not found for id: {} | This error occurs when attempting to retrieve a user by ID, but no user exists with the specified id |
| USR_123 { #USR_123 } | 404 | Resource not found for id: {} | This error occurs when attempting to access a resource that does not exist for the specified id |
| USR_124 { #USR_124 } | 403 | {} | This error occurs when the the specified operation is not authorised |
| USR_125 { #USR_125 } | 404 | Subject not found for id: {} | This error occurs when attempting to retrieve a resource by id, but no resource exists with the specified id |
| USR_126 { #USR_126 } | 401 | Invalid webhook secret token | This error occurs when the provided webhook secret token is invalid or does not match the expected value |
| USR_127 { #USR_127 } | 409 | Identity already exists | This error occurs when attempting to create user in identity service, but the identity already exists |
| USR_128 { #USR_128 } | 409 | Managed User with username ‘{}’ already exist | This error occurs when there is a conflict with the identity, such as a username already existing when trying to create a user in identity service |
| USR_129 { #USR_129 } | 400 | {} | This error occurs when the provided username is invalid or does not meet the required format when calling identity service |
| USR_130 { #USR_130 } | 400 | {} | This error occurs when the request is malformed or contains invalid parameters when calling identity service |
| USR_131 { #USR_131 } | 409 | {} | This error occurs when attempting to update a user in identity service, but there is a conflict |
| USR_132 { #USR_132 } | 400 | Cannot update when user is in pending state | This error occurs when attempting to update a user in identity service who is in a pending state. |
| USR_133 { #USR_133 } | 409 | User with email {} already exists | This error occurs when attempting to create a user with an email address that is already associated with an existing user |
| USR_134 { #USR_134 } | 400 | Error downloading image: invalid URL | This error occurs when the provided image URL is invalid or cannot be accessed |
| USR_135 { #USR_135 } | 409 | Account cannot have multiple owners | This error occurs when attempting to create a user with a role that would make them an owner of an account and there is already an owner in the account |
| USR_136 { #USR_136 } | 409 | Account cannot have multiple owners | This error occurs when attempting to create a user with a role that would make them an owner of an account and there is already an owner in the account |
| USR_137 { #USR_137 } | 409 | Account cannot have multiple owners | This error occurs when attempting to assign multiple owners to an account, which is not allowed |
| USR_138 { #USR_138 } | 400 | Account {} should be a {} account | This error occurs when account type mismatch happens either with customer or dealer account when trying to list users of the customer account |
| USR_139 { #USR_139 } | 404 | Account not found for id: {} | This error occurs when the specified account id does not exist when trying to list users of customer account |
| USR_140 { #USR_140 } | 404 | Relationship not found between given accounts | This error occurs when the specified relationship between the provided accounts does not exist |
| USR_141 { #USR_141 } | 400 | Invalid filter query | This error occurs when the provided filter query is not valid or cannot be parsed when trying to list users in customer account |
| USR_142 { #USR_142 } | 500 | Error in invitation acceptance | This error occurs when there is an internal failure in processing the invitation acceptance |
| USR_143 { #USR_143 } | 400 | Country cannot be empty or spaces when provided | This error occurs when the country field is provided but is empty, which is not allowed |
| USR_144 { #USR_144 } | 400 | Language cannot be empty or spaces when provided | This error occurs when the language field is provided but is empty, which is not allowed |
| USR_145 { #USR_145 } | 400 | Timezone cannot be empty or spaces when provided | This error occurs when the timezone field is provided but is empty, which is not allowed |
| USR_146 { #USR_146 } | 400 | Email address cannot be updated | This error occurs when an attempt is made to update the email address, which is not allowed. |
| USR_147 { #USR_147 } | 403 | Not Authorized to perform this operation | This error occurs when a user attempts to delegate a role that they are not authorized to delegate |
| USR_148 { #USR_148 } | 403 | Not authorized to update user in the account | This error occurs when an attempt is made to update default account, but not authorized |
| USR_149 { #USR_149 } | 404 | Account not found for id: {} | This error occurs when the specified account id does not exist in the system |
| USR_150 { #USR_150 } | 404 | Account not found for id: {} | This error occurs when the specified account id does not exist when trying to swap roles in an account |
| USR_151 { #USR_151 } | 404 | Role {} is not assigned to the user {} in account {} | This error occurs when attempting to swap a role that is not assigned to the user in the specified account |
| USR_152 { #USR_152 } | 404 | Relation not found between user {} and account {} | This error occurs when attempting to swap roles between a user and an account, but no relation exists |
| USR_153 { #USR_153 } | 404 | User not found for id: {} | This error occurs when the specified user id does not exist when trying to swap roles in an account |
| USR_154 { #USR_154 } | 400 | Users in ‘from’ and ‘to’ must be different | This error occurs when attempting to swap roles of the same user, which is not allowed |
| USR_155 { #USR_155 } | 400 | Roles in ‘from’ and ‘to’ must be different | This error occurs when attempting to swap the same role for a user, which is not allowed |
| USR_156 { #USR_156 } | 400 | uuids list must contain minimum of 1 and maximum of {} items | This error occurs when the uuids list is empty or exceeds the maximum allowed size |
| USR_157 { #USR_157 } | 400 | Status must be either ACTIVE or not specified | This error occurs when a status other than ‘ACTIVE’ is provided for searching by email |
| USR_158 { #USR_158 } | 400 | Role {} not found | This error occurs when the role is not found |
| USR_159 { #USR_159 } | 500 | Internal server error | An internal issue has occurred while transaction write operation |
| USR_160 { #USR_160 } | 400 | Timezone: {} is not supported for Country: {} | This error occurs when the provided timezone is not supported for the specified country |
| USR_161 { #USR_161 } | 400 | Invalid Country and Timezone combination. Timezone should match with Country: {} | This error occurs when the provided timezone does not match the specified country |
| USR_162 { #USR_162 } | 400 | Timezone is mandatory while updating country for a user | This error occurs when the country is provided but the timezone field is missing during an user update |
| USR_163 { #USR_163 } | 400 | emails list must contain minimum of 1 and maximum of {} items | This error occurs when the email list is empty or exceeds the maximum allowed size |
| USR_164 { #USR_164 } | 500 | Internal error when updating user in identity system | This error occurs when there is an internal failure while trying to update a user in the identity system. Raise a support ticket. |
| USR_165 { #USR_165 } | 500 | Internal error when reserving user id in identity system | This error occurs when there is an internal failure while trying to reserve uuid for the user in the identity system. Raise a support ticket. |
| USR_166 { #USR_166 } | 500 | Internal error when deleting user in identity system | This error occurs when there is an internal failure while trying to delete a user in the identity system. Raise a support ticket. |
| USR_167 { #USR_167 } | 400 | Email cannot be empty while creating user | This error occurs when trying to create a user with email as empty string. |
| USR_168 { #USR_168 } | 500 | Internal error when updating ttl for user in identity system | This error occurs when there is an internal failure while trying to update ttl for a user in the identity system.Raise a support ticket. |
| USR_169 { #USR_169 } | 404 | User not found for id: {}. Please find the data in region: {} | This error occurs when attempting to retrieve a user by ID, but no user exists with the specified id |
| USR_170 { #USR_170 } | 404 | User not found for id: {} | This error occurs when TiD attempts to delete a user, but the specified user does not exist |
| USR_171 { #USR_171 } | 400 | Context data size exceeded max size: {} characters | This error occurs when the size of the context data exceeds the maximum allowed size |
| USR_172 { #USR_172 } | 400 | Invalid upload data provided | This error occurs when the provided data is invalid or cannot be processed |
| USR_173 { #USR_173 } | 400 | The file has {} content. | This error occurs when the uploaded file contains unsafe content as detected by the system |
| USR_174 { #USR_174 } | 404 | User invitation request not found: {} | This error occurs when no request is found for the specified id |
| USR_175 { #USR_175 } | 400 | CSV size exceeded max size: {} MB | This error occurs when the uploaded csv’s size exceeds the maximum allowed size |
| USR_176 { #USR_176 } | 400 | CSV File not Found | This error occurs when the csv file is missing in the request. |
| USR_177 { #USR_177 } | 400 | media type: {} not supported | This error occurs when the provided media type is not supported |
| USR_178 { #USR_178 } | 404 | Invitation does not exist for id: {} | This error occurs when attempting to access an invitation that does not exist for the specified invitation id |
| USR_179 { #USR_179 } | 400 | Either id or email required | This error occurs when either id or email is not provided |
| USR_180 { #USR_180 } | 400 | Only owner role can be transferred | This error occurs when attempting to transfer a role that is not the owner role |
| USR_181 { #USR_181 } | 400 | Invalid {} ID | This error occurs when the provided ID is not in UUID format |
| USR_182 { #USR_182 } | 400 | Owner role transfer is already pending for this account | This error occurs when there is already a pending owner role transfer for the specified account |
| USR_183 { #USR_183 } | 403 | User is not the owner of the account | This error occurs when the user attempting to perform an action is not the owner of the specified account |
| USR_184 { #USR_184 } | 400 | Either id or email required but not both | This error occurs when both id and email are provided instead of just one |
| USR_185 { #USR_185 } | 400 | Owner role transfer to self is not allowed | This error occurs when a user attempts to transfer the owner role to themselves |
| USR_186 { #USR_186 } | 400 | Invalid sort order | This error occurs when the provided sort order is not valid when trying to list users |
| USR_187 { #USR_187 } | 404 | Organization with id {} not found | This error occurs when the specified organization does not exist |
| USR_188 { #USR_188 } | 403 | Not authorized to perform this operation | This error occurs when the user does not have permission to fetch users in an organization |
| USR_189 { #USR_189 } | 400 | Invalid target type | This error occurs when the target type is not valid |
| USR_190 { #USR_190 } | 404 | User not found for id: {} | This error occurs when a user is not found, while attempting to delete them for data_region switch |
| USR_210 { #USR_210 } | 409 | (‘USR_133’, 409, ‘User with email {} already exists’, ‘This error occurs when attempting to create a user with an email address that is already associated with an existing user’) | This error occurs when a user with the specified ID already exists in the system when attempting to create user for region switch |
| USR_211 { #USR_211 } | 400 | Invalid createdBy format: {} | This error occurs when the createdBy field in the request is not in the expected format |
| USR_191 { #USR_191 } | 400 | Either accountId or groupId query parameter is required | This error occurs when both accountId and groupId query parameters are provided when inviting a user |
| USR_192 { #USR_192 } | 400 | Email cannot be empty or whitespace | This error occurs when the email field is provided but is empty or contains only whitespace |
| USR_193 { #USR_193 } | 409 | Concurrent modification detected. Please retry the operation. | This error occurs when there is a concurrent modification to the user’s roles, causing a conditional check to fail during an update. Retrying the operation may resolve the issue. |
| USR_194 { #USR_194 } | 404 | Picture does not exist | This error occurs when the requested picture for the user does not exist when trying to get user picture |
| USR_195 { #USR_195 } | 404 | No relation exists between user {} and account {} | This error occurs when no relation exists between the user and the account when trying to add a user to an account |
| USR_196 { #USR_196 } | 400 | Invalid include query parameter | This error occurs when any of the provided include query parameters is not supported |
| USR_197 { #USR_197 } | 400 | sortBy is required when pageIndex is used | This error occurs when pageIndex is provided without a sortBy field for offset-based pagination |
| USR_198 { #USR_198 } | 400 | {} | This error occurs when the id=in=(…) filter exceeds the maximum allowed number of ids |
| USR_199 { #USR_199 } | 500 | Internal error when deleting ttl for user in identity system | This error occurs when there is an internal failure while trying to delete ttl for a user in the identity system. |
| USR_200 { #USR_200 } | 400 | Invalid or undecodable smsMsgTemplate | This error occurs when smsMsgTemplate is not valid base64 or cannot be decoded as UTF-8 |
| USR_201 { #USR_201 } | 400 | smsMsgTemplate must contain required placeholder(s): {} | This error occurs when the decoded smsMsgTemplate is missing one or more required placeholders |
| USR_202 { #USR_202 } | 400 | activationPhoneNumber is required when smsMsgTemplate is provided | This error occurs when smsMsgTemplate is provided without activationPhoneNumber |
| USR_203 { #USR_203 } | 400 | Invalid activationPhoneNumber format | This error occurs when activationPhoneNumber is not a valid phone number |
| USR_204 { #USR_204 } | 400 | smsMsgTemplate must not exceed {} characters | This error occurs when the decoded smsMsgTemplate exceeds the maximum length of 140 characters |
| USR_205 { #USR_205 } | 400 | activationPhoneNumber country {} is not supported | This error occurs when activationPhoneNumber belongs to a country not in the supported list |
| USR_206 { #USR_206 } | 400 | tempPassword must not be provided when activationPhoneNumber is provided | This error occurs when tempPassword or password is provided along with activationPhoneNumber, which activates the user via SMS |
| USR_207 { #USR_207 } | 400 | redirectUrl is required when smsMsgTemplate or activationPhoneNumber is provided | This error occurs when smsMsgTemplate or activationPhoneNumber is provided without redirectUrl |
| USR_208 { #USR_208 } | 400 | redirectUrl must use the https scheme | This error occurs when redirectUrl is provided with a scheme other than https |
| USR_209 { #USR_209 } | 400 | redirectUrl is only allowed when smsMsgTemplate or activationPhoneNumber is provided | This error occurs when redirectUrl is provided without smsMsgTemplate or activationPhoneNumber |
| USR_210 { #USR_210 } | 404 | User not found in TID | This error occurs when the user identity is not found in Trimble Identity in any requested region |
| USR_211 { #USR_211 } | 400 | Identity has no email; refresh not supported | This error occurs when attempting to refresh a user whose TID identity has no email address |
| USR_212 { #USR_212 } | 403 | Application not authorized to refresh users | This error occurs when the calling application is not on the refresh user allowlist |
| USR_213 { #USR_213 } | 404 | Reserved identity no longer exists in any region; re-issue the invitation | This error occurs when updating TTL for a reserved user during invitation resend, but the reserved identity record is not present in any region. The caller should create a new invitation. |
| USR_250 { #USR_250 } | 400 | DPoP proof validation failed | This error occurs when the DPoP proof is invalid (missing/malformed proof, bad signature, htm/htu mismatch, or jti replay) |
| USR_251 { #USR_251 } | 401 | DPoP token binding failed | This error occurs when DPoP token binding fails (ath mismatch, cnf.jkt mismatch, or Bearer used with a DPoP-bound token) |
| USR_400 { #USR_400 } | 400 | Generic message: ‘Spec mismatch error’ | This error occurs when there is a mismatch between the OpenAPI spec and the request submitted. Please verify the request against the spec. If you notice the error is not a spec mismatch raise a support ticket |
| USR_500 { #USR_500 } | 500 | Generic message: ‘Internal server error’ | This error occurs due to some internal problem. Immediately raise a support ticket |
| /// |
/// tab | Bootstrap
| Error code | Http status code | Error message | Description |
|---|---|---|---|
| BTS_001 { #BTS_001 } | 400 | Missing required field - csr | This error occurs when csr field is missing in payload |
| BTS_002 { #BTS_002 } | 400 | CSR should not be empty | This error occurs when csr field is empty in payload |
| BTS_003 { #BTS_003 } | 400 | Invalid CSR PEM | This error occurs when the CSR PEM given in payload is invalid |
| BTS_004 { #BTS_004 } | 400 | Exception in extracting public key from CSR | This error occurs when publicKey extraction from CSR fails |
| BTS_005 { #BTS_005 } | 400 | CSR signature validation failed | This error occurs when CSR signature validation fails |
| BTS_006 { #BTS_006 } | 404 | Entity corresponding to the common_name not found | This error occurs when entity corresponding to the common_name in the CSR is not found |
| BTS_007 { #BTS_007 } | 400 | {0} reached certificate rotation limit. Next certificate rotation can be requested after {1} | This error occurs when entity has reached SuccessRotationLock |
| BTS_008 { #BTS_008 } | 400 | {0} locked due to exceeding failure certificate rotation limit. Please unlock {1} or next certificate rotation can be requested after {2} | This error occurs when entity has reached FailureRotationLock |
| BTS_300 { #BTS_300 } | [400, 404] | Generic message: ‘Error from Certificate API’ | This error occurs when an error occurred while processing the certificate request through the Certificate API. |
| BTS_009 { #BTS_009 } | 400 | Operation not allowed for a blocked device | This error occurs when a bootstrap operation is attempted on a device with blocked status |
| BTS_250 { #BTS_250 } | 400 | DPoP proof validation failed | This error occurs when the DPoP proof is invalid (missing/malformed proof, bad signature, htm/htu mismatch, or jti replay) |
| BTS_251 { #BTS_251 } | 401 | DPoP token binding failed | This error occurs when DPoP token binding fails (ath mismatch, cnf.jkt mismatch, or Bearer used with a DPoP-bound token) |
| BTS_500 { #BTS_500 } | 500 | Internal server error | This error occurs due to some internal problem. Immediately raise a support ticket |
| BTS_400 { #BTS_400 } | 400 | Generic message: ‘Spec mismatch error’ | This error occurs when there is a mismatch between the OpenAPI spec and the request submitted. Please verify the request against the spec. If you notice the error is not a spec mismatch raise a support ticket |
| BTS_500 { #BTS_500 } | 500 | Generic message: ‘Internal server error’ | This error occurs due to some internal problem. Immediately raise a support ticket |
| /// |
/// tab | Groups
| Error code | Http status code | Error message | Description |
|---|---|---|---|
| GRP_001 { #GRP_001 } | 400 | Group with id: {} has multiple accounts | This error occurs when the given group id has multiple accounts |
| GRP_002 { #GRP_002 } | 404 | {} not found for id: {} | This error occurs when the resource/entity is not found or available |
| GRP_003 { #GRP_003 } | 403 | Not authorized to perform the operation | This error occurs when the resource is not authorized to perform the operation |
| GRP_004 { #GRP_004 } | 409 | Group with name: {} already exists | This error occurs when the group with given name already exists |
| GRP_005 { #GRP_005 } | 400 | Invalid filter query | This error occurs when parsed filter query is invalid |
| GRP_006 { #GRP_006 } | 403 | Application token is not allowed for this operation | This error occurs when given Application token is not allowed for this operation |
| GRP_007 { #GRP_007 } | 400 | Maximum allowed size exceeded for the query | This error occurs when the query exceeds maximum allowed size. |
| GRP_008 { #GRP_008 } | 403 | User token is not allowed for this operation | This error occurs when given User token is not allowed for this operation |
| GRP_009 { #GRP_009 } | 404 | Relation not found for user: {} and account: {} | This error occurs when relation not found for user and account |
| GRP_010 { #GRP_010 } | 404 | User {} does not exists | This error occurs when user not exists |
| GRP_011 { #GRP_011 } | 404 | Relation not found for application: {} and account: {} | This error occurs when Relation not found for application and account |
| GRP_012 { #GRP_012 } | 404 | Application {} does not exists | This error occurs when application not exists |
| GRP_013 { #GRP_013 } | 403 | Role assignment group cannot be updated | This error occurs when role assignment group cannot be updated |
| GRP_014 { #GRP_014 } | 403 | Role assignment group cannot be deleted | This error occurs when role assignment group cannot be deleted |
| GRP_015 { #GRP_015 } | 409 | user with id: {} already added to given group | This error occurs when user with id already exists in given group |
| GRP_016 { #GRP_016 } | 404 | Relation not found for user: {} | This error occurs when relation not found for user |
| GRP_017 { #GRP_017 } | 409 | device with id: {} already added to given group | This error occurs when device with id already exists in given group |
| GRP_018 { #GRP_018 } | 500 | Internal server error | This error occurs when the transaction is canceled |
| GRP_019 { #GRP_019 } | 404 | Relation not found for device: {} | This error occurs when relation not found for device |
| GRP_020 { #GRP_020 } | 409 | application with id: {} already added to given group | This error occurs when application with id already exists in given group |
| GRP_021 { #GRP_021 } | 400 | Duplicate role ids found | This error occurs when duplicate role ids found |
| GRP_022 { #GRP_022 } | 404 | Relation not found for application: {} | This error occurs when relation not found for application |
| GRP_023 { #GRP_023 } | 404 | Account not found for device: {} | This error occurs when account not found for device |
| USR_008 { #USR_008 } | 400 | The provided email does not contain an ‘@’ symbol | This error occurs when the email does not contain an ‘@’ symbol |
| USR_009 { #USR_009 } | 400 | The user part or domain part of the given email is invalid | This error occurs when the email’s user part or domain part does not match the expected regex pattern |
| GRP_024 { #GRP_024 } | 404 | Device {} does not exists | This error occurs when device not exists |
| GRP_025 { #GRP_025 } | 404 | Role {} not found | This error occurs when role not exists |
| GRP_026 { #GRP_026 } | 403 | Role {} is scoped to a different account | This error occurs when role is scoped to a different account |
| GRP_027 { #GRP_027 } | 403 | Not authorized to access other application role {} | This error occurs when try to access other application role |
| GRP_028 { #GRP_028 } | 409 | Group {} is still in use and cannot be deleted | This error occurs when trying to delete the group which is still in use |
| GRP_029 { #GRP_029 } | 404 | Role assignment group not found | This error occurs when role assignment group not found |
| GRP_030 { #GRP_030 } | 400 | on query parameter is required to get group associated with the role | This error occurs when query parameter not provided to get group associated with the role |
| GRP_031 { #GRP_031 } | 400 | Invalid TRN format in on query parameter | This error occurs when TRN format is invalid on query parameter |
| GRP_032 { #GRP_032 } | 400 | Only group and account TRN are allowed in on query parameter | This error occurs when a TRN that is neither a group nor an account TRN is provided in query parameter |
| GRP_033 { #GRP_033 } | 403 | {} | This error occurs if group is a virtual group |
| GRP_034 { #GRP_034 } | 400 | Group {} should follow the constraints | This error occurs if group name not followed name constraints |
| GRP_035 { #GRP_035 } | 400 | Field required | This error occurs if any required field missing |
| GRP_036 { #GRP_036 } | 400 | Role Ids field must be a list of strings | This error occurs if role id type is invalid |
| GRP_037 { #GRP_037 } | 400 | The isLocal parameter is only valid when the parent group id is provided. | This error occurs if isLocal parameter is provided but the parent group id is not provided |
| GRP_038 { #GRP_038 } | 400 | Invalid value for isLocal parameter. It should be either true or false. | This error occurs if Invalid value given for isLocal parameter. It should be either true or false. |
| GRP_039 { #GRP_039 } | 400 | Cannot create group under nested or role assignment group | This error occurs when we try to create group under nested or role assignment group |
| GRP_040 { #GRP_040 } | 403 | Cannot add non-member of parent group to a local nested group | This error occurs when we try to add non-member of parent group to a local nested group |
| GRP_041 { #GRP_041 } | 404 | No owner found for account: {} | This error occurs when we try to get the owner of an account and no owner is found |
| GRP_042 { #GRP_042 } | 404 | User with id: {} not exists in the given group | This error occurs when user with id already exists in given group |
| GRP_043 { #GRP_043 } | 400 | roleIds is required to update user group relation | This error occurs when role ids are missing in the update request |
| GRP_044 { #GRP_044 } | 404 | No owner/admin found for the group: {} | This error occurs when we try to get the owner/admin of an group and no owner is found |
| GRP_045 { #GRP_045 } | 500 | Unable to send email to group owners | Internal server error occurs when email sending fails |
| GRP_046 { #GRP_046 } | 400 | Invalid email request {} | This error occurs when the email request is invalid |
| GRP_047 { #GRP_047 } | 400 | Role cannot be empty or spaces when provided, must be list of non-empty strings | This error occurs when the role field is provided but is empty, which is not allowed |
| GRP_048 { #GRP_048 } | 400 | templateId cannot be empty or spaces when provided | This error occurs when the template field is provided but is empty, which is not allowed |
| GRP_049 { #GRP_049 } | 404 | No owner with email found for the group: {} | This error occurs when we try to get the owner of an group and no owner is found |
| GRP_050 { #GRP_050 } | 400 | Only users can request to join groups | This error occurs when any other subject type other than user tries to request to join groups |
| GRP_051 { #GRP_051 } | 404 | {} not found for id: {}. Please find the data in region: {} | This error occurs when the resource/entity is not found or available |
| GRP_052 { #GRP_052 } | 400 | Resource with id: {} is not committed in its default account | This error occurs when the resource is not committed in it’s default account while adding to group |
| GRP_053 { #GRP_053 } | 400 | Invalid include query parameter | This error occurs when parsed include query parameter is invalid |
| GRP_054 { #GRP_054 } | 400 | Invalid value for allowAsyncCascadeDelete parameter. It should be either true or false. | This error occurs if Invalid value given for allowAsyncCascadeDelete parameter. It should be either true or false. |
| GRP_055 { #GRP_055 } | 404 | No users found for the group: {} with roles: {} | This error occurs when we try to get the users of an group |
| GRP_056 { #GRP_056 } | 403 | provided admin role ID does not have the required permissions needed for admin users | This error occurs when the admin role ID does not have the required permissions: roles:assign, users:add |
| GRP_057 { #GRP_057 } | 400 | Field required: {} | This error occurs if any required field missing |
| GRP_058 { #GRP_058 } | 409 | User already has a pending request. You can resend the request after 24 hours. | This error occurs when a user attempts to resend a request within 24 hours of a previously submitted pending request |
| GRP_059 { #GRP_059 } | 400 | Invalid action parameter: {}. Allowed values are APPROVE, REJECT, RESEND, CANCEL | This error occurs when an invalid action parameter is provided in the query param |
| GRP_060 { #GRP_060 } | 400 | Role cannot be empty or spaces | This error occurs when the role field provided but is empty |
| GRP_061 { #GRP_061 } | 400 | Role must be a valid UUID | This error occurs when the role field provided is not a valid UUID |
| GRP_062 { #GRP_062 } | 404 | No pending relation found between user {} and group {} | This error occurs when there is no pending group join request found for the user and group |
| GRP_063 { #GRP_063 } | 403 | Role {} is not owned by the calling application | This error occurs when the role being assigned is not owned by the calling application |
| GRP_064 { #GRP_064 } | 400 | Invalid {} ID | This error occurs when the provided ID is not in UUID format |
| GRP_065 { #GRP_065 } | 404 | Relation not found between user: {} and group: {} | This error occurs when relation not found for user and group |
| GRP_066 { #GRP_066 } | 400 | roleIds is required to update application group relation | This error occurs when role ids are missing in the update request |
| GRP_067 { #GRP_067 } | 404 | Application with id: {} does not exist in the given group | This error occurs when application with does not exist in given group |
| GRP_068 { #GRP_068 } | 400 | application id is required to update application group relation | This error occurs when application id is null in the update request |
| GRP_069 { #GRP_069 } | 403 | Only user can cancel the join requests | This error occurs when any other subject type other than user tries to cancel the join requests |
| GRP_070 { #GRP_070 } | 404 | No pending join request found for user: {} and group: {} | This error occurs when there is no pending join request found for the user and group |
| GRP_071 { #GRP_071 } | 400 | Request payload not supported for the action: {} | This error occurs when request payload is provided for the action which is not support in payload |
| GRP_072 { #GRP_072 } | 400 | No invitation found for user: {} and group: {} to resend | This error occurs when there is no invitation found for the user and group to resend |
| GRP_073 { #GRP_073 } | 400 | Invitation can only be resent after 24 hours of the previous pending request | This error occurs when a user attempts to resend an invitation within 24 hours of a previously submitted pending request |
| GRP_074 { #GRP_074 } | 400 | No relation found for user: {} and group: {} to cancel invitation | This error occurs when there is no relation found for the user and group to cancel invitation |
| GRP_075 { #GRP_075 } | 400 | No pending invitation found for user: {} and group: {} to cancel | This error occurs when there is no pending invitation found for the user and group to cancel |
| GRP_076 { #GRP_076 } | 500 | No invitation id found for user: {} and group: {} to cancel | This error occurs when there is no invitation id found for the user and group to cancel invitation, raise a support ticket to investigate the issue |
| GRP_077 { #GRP_077 } | 500 | Unable to cancel invitation | Internal server error occurs when invitation cancellation fails |
| GRP_078 { #GRP_078 } | 400 | Request payload cannot be empty for approve action | This error occurs when the request payload is empty for approve action in group join request approval process |
| GRP_079 { #GRP_079 } | 400 | Request payload cannot be empty for reject action | This error occurs when the request payload is empty for reject action in group join request approval process |
| GRP_080 { #GRP_080 } | 400 | No relation found for user: {} and group: {} to resend invitation | This error occurs when there is no relation found for the user and group to resend invitation |
| GRP_081 { #GRP_081 } | 400 | No pending invitation found for user: {} and group: {} to resend | This error occurs when there is no pending invitation found for the user and group to resend invitation |
| GRP_082 { #GRP_082 } | 403 | Only admin-invite requests can be resent | This error occurs when attempting to resend a self-join request instead of an admin invite |
| GRP_083 { #GRP_083 } | 403 | Only admin-invite requests can be cancelled | This error occurs when attempting to cancel a self-join request instead of an admin invite |
| GRP_084 { #GRP_084 } | 403 | Only self join-invite requests can be approved | This error occurs when attempting to approve a admin request instead of an self join invite |
| GRP_085 { #GRP_085 } | 403 | Only self join-invite requests can be rejected | This error occurs when attempting to reject a admin request instead of an self join invite |
| GRP_086 { #GRP_086 } | 400 | Operation not allowed for a blocked device | This error occurs when a group operation is attempted on a device with blocked status |
| GRP_087 { #GRP_087 } | 400 | Invalid join action parameter: {}. Allowed values are ACCEPT, REJECT | This error occurs when an invalid action query parameter is provided for the join endpoint |
| GRP_088 { #GRP_088 } | 400 | Accept or reject action is required for the pending admin user invite for group: {} | This error occurs when a user with a pending admin user invite calls the join endpoint without action=ACCEPT or action=REJECT |
| GRP_089 { #GRP_089 } | 400 | Invalid sort order | This error occurs when the provided sort order is not valid. {} |
| GRP_090 { #GRP_090 } | 404 | Relation not found | This error occurs when a relation targeted by a transactional operation no longer exists |
| GRP_091 { #GRP_091 } | 400 | roleIds is required to update device group relation | This error occurs when role ids are missing in the update request |
| GRP_092 { #GRP_092 } | 404 | Device with id: {} does not exist in the given group | This error occurs when device does not exist in given group |
| GRP_250 { #GRP_250 } | 400 | DPoP proof validation failed | This error occurs when the DPoP proof is invalid (missing/malformed proof, bad signature, htm/htu mismatch, or jti replay) |
| GRP_251 { #GRP_251 } | 401 | DPoP token binding failed | This error occurs when DPoP token binding fails (ath mismatch, cnf.jkt mismatch, or Bearer used with a DPoP-bound token) |
| GRP_400 { #GRP_400 } | 400 | Generic message: ‘Spec mismatch error’ | This error occurs when there is a mismatch between the OpenAPI spec and the request submitted. Please verify the request against the spec. If you notice the error is not a spec mismatch raise a support ticket |
| GRP_500 { #GRP_500 } | 500 | Generic message: ‘Internal server error’ | This error occurs due to some internal problem. Immediately raise a support ticket |
| /// |
/// tab | Accounts
| Error code | Http status code | Error message | Description |
|---|---|---|---|
| ACT_001 { #ACT_001 } | 404 | The requested resource was not found. | The resource you are looking for does not exist. |
| ACT_002 { #ACT_002 } | 400 | The request could not be understood or was missing required parameters. | Please check the request parameters and try again. |
| ACT_003 { #ACT_003 } | 403 | You do not have permission to access the requested resource. | You might not have the necessary permissions to access this resource. |
| ACT_004 { #ACT_004 } | 401 | Authentication is required and has failed or has not yet been provided. | Please authenticate and try again. |
| ACT_005 { #ACT_005 } | 404 | User {user_id} not found for account {account_id}. | The specified user does not exist for the given account. |
| ACT_006 { #ACT_006 } | 404 | Address {address_id} not found for account {account_id}. | The specified address does not exist for the given account. |
| ACT_007 { #ACT_007 } | 404 | Reference not found for external system {external_system_id} on {context}. | The specified reference does not exist for the given external system. |
| ACT_008 { #ACT_008 } | 404 | External system with id {external_system_id} not found. | The specified external system does not exist. |
| ACT_009 { #ACT_009 } | 404 | Account {account_id} not found or you do not have sufficient permissions to access it. | The resource may not exist or your permissions may be insufficient. |
| ACT_010 { #ACT_010 } | 403 | You do not have sufficient permissions to access the requested resource. | Your permissions are insufficient to access the resource. |
| ACT_011 { #ACT_011 } | 501 | The requested functionality is not implemented. | This functionality is not yet implemented in the system. |
| ACT_012 { #ACT_012 } | 400 | Invalid cursor provided for pagination. | The cursor provided for pagination is not valid. |
| ACT_013 { #ACT_013 } | 409 | Conflict with the current state of the resource. | The request could not be completed due to a conflict with the current state of the resource. |
| ACT_014 { #ACT_014 } | 400 | Restricted entity type. | The entity type provided is restricted and cannot be used. |
| ACT_015 { #ACT_015 } | 400 | Account short code is immutable. | The account short code cannot be changed once set. |
| ACT_016 { #ACT_016 } | 400 | Account description exceeds maximum length. | The account description provided is too long. |
| ACT_016 { #ACT_016 } | 400 | Common layer error occurred. | An error occurred in the common layer. |
| ACT_017 { #ACT_017 } | 409 | Duplicate account short code. | The account short code provided already exists. |
| ACT_018 { #ACT_018 } | 409 | Duplicate external system reference. | The reference for the external system already exists. |
| ACT_019 { #ACT_019 } | 400 | Invalid account ID. | Account Id must be a valid UUID |
| ACT_020 { #ACT_020 } | 400 | Invalid account name. | Account name is not within allowed length bounds. |
| ACT_021 { #ACT_021 } | 400 | Invalid account type. | The account type provided is not valid. |
| ACT_022 { #ACT_022 } | 400 | Invalid country code. | Country code is not a valid ISO 3166 alpha-2 country code. |
| ACT_023 { #ACT_023 } | 400 | Invalid currency code. | The currency code provided is not valid. |
| ACT_024 { #ACT_024 } | 400 | Invalid customer type. | The customer type provided is not valid. |
| ACT_025 { #ACT_025 } | 400 | Invalid email address. | The email address provided is not valid. |
| ACT_026 { #ACT_026 } | 400 | Invalid PO Box. | The PO Box provided is not valid. |
| ACT_027 { #ACT_027 } | 400 | Postal Code exceeds maximum allowed length. | The postal code length provided is not valid. |
| ACT_029 { #ACT_029 } | 400 | The default shipping address must be an address with a ‘SHIPPING’ type. | An attempt was made to set a default shipping address to an address that is not of type ‘SHIPPING’. |
| ACT_030 { #ACT_030 } | 400 | Invalid tax exemption. Accepted values are: tax_exempted, vat_exempted, no_exemption. | The tax exemption status provided is not valid. |
| ACT_031 { #ACT_031 } | 400 | External system ID must be a valid UUID | The external system ID provided is not valid. |
| ACT_032 { #ACT_032 } | 400 | Maximum references exceeded. | The maximum number of references for the external system has been exceeded. |
| ACT_033 { #ACT_033 } | 409 | Unique constraint violated. | A unique constraint has been violated in the database. |
| ACT_034 { #ACT_034 } | 400 | Unexpected reference state for transaction | The state provided in the reference is not valid. |
| ACT_036 { #ACT_036 } | 409 | Cannot create multiple relation to the same account | The account relationship being created already exists. |
| ACT_037 { #ACT_037 } | 400 | Decommissioned external system. | The external system being referenced has been decommissioned and can no longer be used. |
| ACT_038 { #ACT_038 } | 400 | New external system. | The external system being referenced is new and must be set up before it can be used. |
| ACT_039 { #ACT_039 } | 400 | Search criteria required. | At least one search criteria must be provided for the search operation. |
| ACT_040 { #ACT_040 } | 400 | Invalid search criteria. | The search criteria provided is not valid. |
| ACT_041 { #ACT_041 } | 400 | RSQL parse error. | The RSQL query provided could not be parsed. Please check the syntax and try again. |
| ACT_042 { #ACT_042 } | 400 | Invalid filter query. | The filter query provided is not valid. Please check the syntax and try again. |
| ACT_043 { #ACT_043 } | 400 | Invalid JSON format. | The JSON format of the request body is invalid. Please ensure it is well-formed JSON. |
| ACT_044 { #ACT_044 } | 403 | Authorization failed. | Authorization failed. Please check your credentials and try again. |
| ACT_045 { #ACT_045 } | 404 | Relation not found. | The specified relation between accounts was not found. |
| ACT_046 { #ACT_046 } | 404 | User not found for the specified email. | The user with the specified email does not exist. |
| ACT_047 { #ACT_047 } | 404 | Account not found for the specified short code. | The account with the specified short code does not exist. |
| ACT_048 { #ACT_048 } | 404 | External systems not found for the specified account. | No external systems are associated with the given account. |
| ACT_049 { #ACT_049 } | 403 | Users not authorized for search operation. | Users are not authorised to perform this search operation. |
| ACT_050 { #ACT_050 } | 400 | Account type must be customer. | The account must be of customer type to perform this operation. |
| ACT_051 { #ACT_051 } | 400 | Account type must be dealer. | The account must be of dealer type to perform this operation. |
| ACT_052 { #ACT_052 } | 400 | Invalid combination of search criteria. | Cannot combine search criteria on source systems and references. |
| ACT_053 { #ACT_053 } | 400 | Cannot combine source and reference search criteria. | Cannot combine search criteria on source systems and references. |
| ACT_054 { #ACT_054 } | 400 | Cannot parse RSQL query. | The RSQL query provided could not be parsed. |
| ACT_055 { #ACT_055 } | 400 | Unsupported search operation. | The search operation provided is not supported. |
| ACT_056 { #ACT_056 } | 400 | Searching for addresses is only supported by CDH ID. | Only search by CDH id is currently supported for addresses |
| ACT_057 { #ACT_057 } | 400 | Invalid account short code characters. | The account short code contains invalid characters. |
| ACT_058 { #ACT_058 } | 400 | Invalid account short code length. | The account short code length is not within the allowed bounds. |
| ACT_059 { #ACT_059 } | 400 | Unexpected account status for operation. | The account status is not valid for the requested operation. |
| ACT_060 { #ACT_060 } | 400 | Unexpected account state for transaction. | The account state is not valid for the requested transaction. |
| ACT_061 { #ACT_061 } | 400 | Invalid account status value. | The account status value provided is not valid. |
| ACT_062 { #ACT_062 } | 400 | Invalid address ID format. | The address ID format provided is not valid. |
| ACT_063 { #ACT_063 } | 400 | Unexpected address ID provided. | An address ID was provided when it should not have been. |
| ACT_064 { #ACT_064 } | 400 | Default billing address must be of billing type. | The default billing address must be marked as a billing address. |
| ACT_065 { #ACT_065 } | 400 | CDH image is missing a required field. | The CDH image provided is missing a required field. |
| ACT_066 { #ACT_066 } | 400 | Street address is required for an adress. | A street address must be provided for the address. |
| ACT_067 { #ACT_067 } | 400 | Cannot delete source system. | The source system of a reference cannot be deleted. |
| ACT_068 { #ACT_068 } | 400 | Cannot update source system. | The source system of a reference cannot be updated. |
| ACT_069 { #ACT_069 } | 400 | Invalid account address relation status for transaction. | The account address relation status is not valid for the requested transaction. |
| ACT_070 { #ACT_070 } | 400 | Invalid address state for transaction. | The address state is not valid for the requested transaction. |
| ACT_071 { #ACT_071 } | 400 | Missing source system. | The source system is not provided for the entity. |
| ACT_072 { #ACT_072 } | 403 | CDH system is protected. | The CDH system cannot be deleted or modified. |
| ACT_073 { #ACT_073 } | 400 | Account manager role is required. | Provide roleIds containing the account manager role for this relation. |
| ACT_074 { #ACT_074 } | 400 | Account manager role already present. | The account manager role is already pending or committed for this relation. |
| ACT_075 { #ACT_075 } | 400 | Invalid Action parameter value | The action parameter provided is not valid. It must be one of: APPROVE, REJECT, REVOKE, CANCEL. |
| ACT_076 { #ACT_076 } | 400 | Missing action query parameter. | The action query parameter is required for this operation. |
| ACT_077 { #ACT_077 } | 400 | Invalid action for the current relation status. | The action parameter provided cannot be performed on the current relation status. |
| ACT_078 { #ACT_078 } | 400 | Action has already been performed. | The action specified has already been performed and cannot be repeated. |
| ACT_079 { #ACT_079 } | 400 | Expiry days should be between 1 and 60 | This error occurs when the provided expiry days for dealer opt in requests are outside the valid range of 1 to 60 |
| ACT_080 { #ACT_080 } | 400 | Invalid subtype for the selected account type. Dealer accounts support Field Systems Dealer and Trimble Tech Outlet. | The subtype provided is not valid for the selected account type. Dealer accounts support Field Systems Dealer and Trimble Tech Outlet. |
| ACT_087 { #ACT_087 } | 400 | Invalid subtype for the selected account type. Customer accounts support Sandbox. | The subtype provided is not valid for the selected account type. Customer accounts support Sandbox. |
| ACT_081 { #ACT_081 } | 400 | subtype can only be set for DEALER or CUSTOMER type accounts. Dealer accounts support Field Systems Dealer and Trimble Tech Outlet.Customer accounts support Sandbox. | The subtype field can only be specified for account types that support subtypes. Dealer accounts support Field Systems Dealer and Trimble Tech Outlet.Customer accounts support Sandbox. |
| ACT_085 { #ACT_085 } | 400 | Sandbox accounts cannot change type or subtype. | Accounts with subtype Sandbox cannot be transitioned to another account type or subtype through update. |
| ACT_086 { #ACT_086 } | 400 | Accounts cannot be transitioned to Sandbox subtype through update. | The Sandbox subtype is immutable in update flows and can only exist when already present on the account. |
| ACT_082 { #ACT_082 } | 400 | Invalid organization verified status. | The organization verified status provided is not valid. Accepted values are: true, false. |
| ACT_083 { #ACT_083 } | 400 | Max size exceeded. | The maximum allowed size has been exceeded. |
| ACT_084 { #ACT_084 } | 404 | Organization not found for id {organization_id}. | The organization with the specified id does not exist. |
| ACT_088 { #ACT_088 } | 400 | Dealer opt-in request is required. | This action cannot be performed until the dealer has sent an opt-in request for this relation. |
| ACT_089 { #ACT_089 } | 409 | Concurrent modification detected. Please retry the operation. | This error occurs when there is a concurrent modification to an external system reference, causing a conditional check to fail during an update. Retrying the operation may resolve the issue. |
| ACT_090 { #ACT_090 } | 400 | groupId query parameter is required for sandbox account creation. | Sandbox account creation requires a groupId query parameter so the parent account can be resolved. |
| ACT_091 { #ACT_091 } | 404 | No account found linked to group {group_id}. | The specified group does not have a linked parent account, so a sandbox account cannot be created. |
| ACT_092 { #ACT_092 } | 400 | Parent account {account_id} must have a CDH external reference to create a sandbox account. | Sandbox account creation requires the parent account to have a CDH external system reference. |
| ACT_500 { #ACT_500 } | 500 | An internal server error occurred. | This error occurs due to some internal problem. Immediately raise a support ticket. |
| ACT_400 { #ACT_400 } | 400 | Spec mismatch error | This error occurs when there is a mismatch between the OpenAPI spec and the request submitted. Please verify the request against the spec. If you notice the error is not a spec mismatch raise a support ticket |
| ACT_009 { #ACT_009 } | 404 | Account {account_id} not found. {exception} | The resource does not exist |
| ACT_250 { #ACT_250 } | 400 | DPoP proof validation failed | This error occurs when the DPoP proof is invalid (missing/malformed proof, bad signature, htm/htu mismatch, or jti replay) |
| ACT_251 { #ACT_251 } | 401 | DPoP token binding failed | This error occurs when DPoP token binding fails (ath mismatch, cnf.jkt mismatch, or Bearer used with a DPoP-bound token) |
| ACT_400 { #ACT_400 } | 400 | Generic message: ‘Spec mismatch error’ | This error occurs when there is a mismatch between the OpenAPI spec and the request submitted. Please verify the request against the spec. If you notice the error is not a spec mismatch raise a support ticket |
| ACT_500 { #ACT_500 } | 500 | Generic message: ‘Internal server error’ | This error occurs due to some internal problem. Immediately raise a support ticket |
| /// |