Skip to content

Latest commit

 

History

History
66 lines (50 loc) · 2.49 KB

update-user-password.md

File metadata and controls

66 lines (50 loc) · 2.49 KB
description
A user's password can be updated with a call that includes the user's current password.

Update a user password

A user can update their password with a call that includes a new password and the user's current password. A member of the System Administrator group can update the password without the need to provide the existing password.

POST /api/management/security/users/{userIdentifier}/credentials/password

Parameters

Name Parameter type Type Description
userIdentifier path UserIdentifier One of the user identifiers

Remarks

If the existing password is wrong then a 409 Conflict status is returned.

If the new password does not meet the password policy then a 422 Unprocessable Entity status is returned.

Example request for user

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

Example request for a System Adminstrator member

POST: /api/management/security/users/9bb89380-fd49-41a5-ab2f-fc25e482a251/credentials/password
{
    "new": "pr0j3ctM4yh3m"
}
POST: /api/management/security/users/[email protected]/credentials/password
{
    "new": "pr0j3ctM4yh3m"
}

Response message

HTTP status code Reason Response model
200 OK - password updated successfully
403 Forbidden Error
404 NotFound Error
409 Conflict - existing password invalid Error
422 Unprocessable Entity - new password invalid Error
500 InternalServerError Error