Links

Set User Password

Name
Requires Auth
Permission
Setting
setUserPassword
Yes
The workspace administrator must enable the Require password change field for the user.

Payload Parameters

Argument
Example
Required
Description
password
pass123
Required
The new password.

Example Call

{
"msg": "method",
"method": "setUserPassword",
"id": "2",
"params": [
"pass123"
]
}

Example Response

{
"msg": "result",
"id": "2",
"result": true
}

Errors

  • Same password: This occurs when the new password is same as the current password.
  • Not Allowed: This occurs when the user does not have Require password change enabled.
Same password
Not allowed
{
"msg": "result",
"id": "2",
"error": {
"isClientSafe": true,
"error": "error-password-same-as-current",
"reason": "Entered password same as current password",
"details": {
"method": "setUserPassword"
},
"message": "Entered password same as current password [error-password-same-as-current]",
"errorType": "Meteor.Error"
}
}
{
"msg": "result",
"id": "2",
"error": {
"isClientSafe": true,
"error": "error-not-allowed",
"reason": "Not allowed",
"details": {
"method": "setUserPassword"
},
"message": "Not allowed [error-not-allowed]",
"errorType": "Meteor.Error"
}
}
Last modified 5mo ago
Rocket.Chat versions receive support for six months after release.