Change the password for a sub-user. In this method, the sub-users can change the passwords on their own.
Name | Data Type | Status | Description |
auth-id | Integer | Required | Authentication parameter |
auth-password | String | Required | Authentication parameter |
id | Integer | Optional | Sub-user's ID. It is required if the API call is not performed on behalf of an API sub-user. |
password | String | Required | The new password |
When the authentication of the API user is not correct, the API request will fail with the following status and statusDescription:
{"status":"Failed","statusDescription": "Invalid authentication, incorrect user ID or password."}
If the API sub-user's ID is invalid, the following status will be returned:
{"status":"Failed","statusDescription":" You don't have permission to do that."}
If the password is too short (min. 6 characters), the following status will be returned:
{"status":"Failed","statusDescription":" This password is too short (min. 6 characters)"}
Note: These are example errors in JSON format, and these are not the only errors that can be displayed.
URL JSON: https://api.cloudns.net/sub-users/modify-password.json
POST/GET: auth-id=0&auth-password=password&id=0&password=password
POST/GET: sub-auth-id=0&auth-password=password&password=password
URL XML: https://api.cloudns.net/sub-users/modify-password.xml
POST/GET: auth-id=0&auth-password=password&id=0&password=password
POST/GET: sub-auth-id=0&auth-password=password&password=password