Set User Password
    • Dark
      Light
    • PDF

    Set User Password

    • Dark
      Light
    • PDF

    Article summary

    Method

    Requires Auth

    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

    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 change enabled.

    {
        "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?

    What's Next
    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.
    ESC

    Eddy AI, facilitating knowledge discovery through conversational intelligence