Enable forced password update

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

Authorizations:
query Parameters
users_json
required
string <json>

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.

Example: users_json={"user1":1,"user2":1,"user3":1}
stop_on_failure
integer
Default: 0

Whether to halt the function if it experiences an error.

  • 1 - Halt on error.
  • 0 - Continue on error.
Enum: 0 1
Example: stop_on_failure=1

Responses

Response Schema: application/json
object
object

Request samples

whmapi1 --output=jsonpretty \
  forcepasswordchange \
  users_json='{"user1":1,"user2":1,"user3":1}'

Response samples

Content type
application/json
{
  • "data": {
    • "updated": [
      • "user"
      ]
    },
  • "metadata": {
    • "command": "forcepasswordchange",
    • "reason": "OK",
    • "result": 1,
    • "version": 1
    }
}