latestOpenAPI 3.0.2cPanel License2026-08-106251554.3 MB

3da41671c02c

Passwords

Enable forced password update

This function forces a user to change the account password after the next login attempt.

get/forcepasswordchange

Query parameters

users_jsonstring json required
Example:{"user1":1,"user2":1,"user3":1}

The list of users. The system will force each user that you specify to change their account's password the next time that they log in.

stop_on_failure0 | 1
Example:1

Whether to halt the function if it experiences an error.

  • 1 - Halt on error.
  • 0 - Continue on error.

Response

HTTP Request was successful.

Example response

{
  "data": {
    "updated": [
      "user"
    ]
  },
  "metadata": {
    "command": "forcepasswordchange",
    "reason": "OK",
    "result": 1,
    "version": 1
  }
}