Modify password

Description

Modify sub user's password


 Parameters

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 API sub-user.
password String Required New password for this sub user

Return: Array with status and status description.


Errors

When the authentication of API user is not correct, any API request will fail with the following status and statusDescription:

{"status":"Failed","statusDescription":"Invalid authentication, incorrect auth-id or auth-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 entered 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

 


Last modified: 2020-01-13
Cookies help us deliver our services. By using our services, you agree to our use of cookies. Learn more