Set User Password
- Print
- DarkLight
- PDF
Set User Password
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Method | Requires Auth |
|---|---|
| Yes |
The workspace administrator must enable the
Require password changefield for the user.
Payload parameters
Argument | Example | Required | Description |
|---|---|---|---|
|
| Required | The new password. |
Example call
{
"msg": "method",
"method": "setUserPassword",
"id": "2",
"params": [
"pass123"
]
}Example response
Success
{
"msg": "result",
"id": "2",
"result": true
}Error
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 changeenabled.
{
"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"
}
}Was this article helpful?