Skip to main content

Update a users password

Log in to add to favourites
POST/api/security/users/{userIdentifier}/credentials/password

Parameter

NameParameter typeTypeFormatDescription
UserIdentifier(required)pathstringuser identifier For convenience, User resources can be referenced by using one of several identifiers - username, email address or Id.

Responses

HTTP status codeReasonModel
200OK - password updated successfully
401UnauthorizedError
403ForbiddenError
404User not foundError
409Invalid existing passwordError
422Password invalidError
500Internal server errorError

Examples

JSON
POST: /api/security/users/9bb89380-fd49-41a5-ab2f-fc25e482a251/credentials/password
{
    "existing": "m4rl451ng3r",
    "new": "pr0j3ctM4yh3m"
}
JSON
POST: /api/security/users/t.durden/credentials/password
{
    "existing": "m4rl451ng3r",
    "new": "pr0j3ctM4yh3m"
}

Example request for a System Adminstrator member

JSON
POST: /api/security/users/9bb89380-fd49-41a5-ab2f-fc25e482a251/credentials/password
{
    "new": "pr0j3ctM4yh3m"
}
JavaScript
POST: /api/security/users/t.durden@fightclub.com/credentials/password
{
    "new": "pr0j3ctM4yh3m"
}

Remarks

If the existing password is wrong then a 409 Conflict status is returned. If the new password does not meet the user password policy then a 422 Unprocessable Entity status is returned.

Still need help?

If you still need help after reading this article, don't hesitate to reach out to the Contensis community on Slack or raise a support ticket to get help from our team.
New support request