Api/UserPasswordEdit

Table of contents

1 Summary

Summary

API: Change the password for a user

A username and a new password are always required

{
  "Key":"{api key}",
  "Username":"{username}"
  "Password":"{new password}"
}

{
  "Key":"abc123def456",
  "Username":"jsmith"
  "Password":"123abc456"
}

The password of admin users can never be changed by API - return "User not found" error
The password of users in other subscriptions can never be changed - return "User not found" error
The password of locked users can not be changed by API - return "Permission denied" error

Non-locked staff users can be changed, but only if the API user is in the super user role. If not return "Permission denied" error.

To change the password of an agent user the API user role must have the "Edit reps, managers" privilege. If not return "Permission denied" error.

If successful the username is returned, otherwise an error is returned

{"UserPasswordEditResult":
  {
    "Username":"{username}",
  }
}

{"UserPasswordEditResult":
  {
    "Username":"jsmith",
  }
}