Change the username for a particular API sub-user.
Name | Data Type | Status | Description |
auth-id | Integer | Required | Authentication parameter |
auth-password | String | Required | Authentication parameter |
id | Integer | Required | Sub-user's ID |
sub-auth-user | String | Required | The new username |
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 sub-user's ID is invalid, the following status will be returned:
{"status":"Failed","statusDescription":"You don't have permission to do that."}
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-username.json
POST/GET: auth-id=0&auth-password=password&id=0&sub-auth-user=username
URL XML: https://api.cloudns.net/sub-users/modify-username.xml
POST/GET: auth-id=0&auth-password=password&id=0&sub-auth-user=username