Resetting Product Authentication Information
Function
Resetting Product Authentication Information
URI
PUT /v2/{project_id}/link/instances/{instance_id}/products/{product_id}/authentication
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID. The default value is default for compatibility with 20.0.Project ID. For details about how to get the project ID, see "Appendix" > "Obtaining a Project ID" in this document. |
instance_id |
Yes |
String |
Instance ID. The default value is default for compatibility with 20.0. |
product_id |
Yes |
Integer |
Product ID. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
User token, which can be obtained by calling the IAM API (value of X-Subject-Token in the response header). |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
user_name |
No |
String |
Product user name, which is a string containing letters, hyphens (-), and digits. |
password |
No |
String |
Product password, which contains 16 to 32 characters, including digits, uppercase letters, lowercase letters, and special characters (-~!@#$ %^&*()-_=+|[{}];:<>/?). If this parameter is left empty, the password will not be reset. If both the username and password are empty, the password will be reset to a system-generated one. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
user_name |
String |
One-model-one-secret or one-device-one-secret username. |
password |
String |
One-model-one-secret or one-device-one-secret password. The password must contain 8 to 32 characters, including at least one digit, one uppercase letter, one lowercase letter, and one special character (~!@#$%^&*()-_=+|[{}];:<>/?). |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
System error code, which is the detailed error code of HTTP error codes 4xx and 5xx. |
error_msg |
String |
Error description. |
request_id |
String |
Message ID. |
Status code: 404
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
System error code, which is the detailed error code of HTTP error codes 4xx and 5xx. |
error_msg |
String |
Error description. |
request_id |
String |
Message ID. |
Status code: 500
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
System error code, which is the detailed error code of HTTP error codes 4xx and 5xx. |
error_msg |
String |
Error description. |
request_id |
String |
Message ID. |
Example Requests
Reset the username and password of a device to specified values.
{"user_name":"4F49B62DD19D46F296AD497C7E81B52E","password":"**********"}
Example Responses
Status code: 200
OK
{ "user_name" : "4MjxbCl4q461", "password" : "**********" }
Status code: 400
Bad Request
{ "error_code" : "SCB.00000000", "error_msg" : "Parameter is not valid for operation [romalink.link-product.resetAuthentication]. Parameter is [productId]. Processor is [path].", "request_id" : "cb39e78a-afd3-4e04-901d-70468b1c23dc-1619602712496-cnnorth7a-P-romalink-service01" }
Status code: 404
Not Found
{ "error_code" : "ROMA.00110006", "error_msg" : "The resource does not exist. Check whether the resource ID ff38023c-0854-4779-847d-72528e1f5da5 is correct.", "request_id" : "72b07918-f6a2-4721-81bf-f3fd5486025e-1619663576836-cnnorth7a-P-romalink-service01" }
Status code: 500
Internal Server Error
{ "error_code" : "ROMA.00110002", "error_msg" : "The instance does not exist. project_id: 397cd10b30544c588b2f4a56d83856c4, instance_id: f3bb386a-23ec-47aa-9943-4c60ac658611", "request_id" : "c8c06d0a-be92-4fdf-9d10-bc20131ab158-1619593104919-cnnorth7a-P-romalink-service01" }
Status Codes
Status Code |
Description |
---|---|
200 |
OK |
400 |
Bad Request |
404 |
Not Found |
500 |
Internal Server Error |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot