> For the complete documentation index, see [llms.txt](https://tech.x2bee.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://tech.x2bee.com/api/api-en/back-office-api-reference/system-bo-api/change-password.md).

# Change Password

## Check Match with Recent Password

> \## Function Description\
> \* Checks whether it matches the recent password.\
> \---\
> \## Detailed Description\
> \* If the new password matches a recent password remaining in the password change history, the password cannot be changed.\
> \* userId, currentPasswd, and newPasswd are required.\
> \* Returns whether it matches the recent password.<br>

```json
{"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"PasswordChangeRequest":{"type":"object","description":"Password Change Request DTO","properties":{"userId":{"type":"string","description":"User ID"},"currentPasswd":{"type":"string","description":"Current Password"},"newPasswd":{"type":"string","description":"New Password"}}},"Response":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string","description":"field"},"message":{"type":"string","description":"field message"}}}}},"paths":{"/v1/system/passwordChange/checkRecentPassword":{"post":{"tags":["Change Password"],"summary":"Check Match with Recent Password","description":"## Function Description\n* Checks whether it matches the recent password.\n---\n## Detailed Description\n* If the new password matches a recent password remaining in the password change history, the password cannot be changed.\n* userId, currentPasswd, and newPasswd are required.\n* Returns whether it matches the recent password.\n","operationId":"checkRecentPassword","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PasswordChangeRequest"}}},"required":true},"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"type":"boolean"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```

## Check Match with Existing Password

> \## Function Description\
> \* Checks whether it matches the existing password.\
> \---\
> \## Detailed Description\
> \* If it matches the existing password, the password cannot be changed.\
> \* userId and currentPasswd are required.\
> \* Returns whether it matches the existing password.<br>

```json
{"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"PasswordChangeRequest":{"type":"object","description":"Password Change Request DTO","properties":{"userId":{"type":"string","description":"User ID"},"currentPasswd":{"type":"string","description":"Current Password"},"newPasswd":{"type":"string","description":"New Password"}}},"Response":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string","description":"field"},"message":{"type":"string","description":"field message"}}}}},"paths":{"/v1/system/passwordChange/checkCurrentPassword":{"post":{"tags":["Change Password"],"summary":"Check Match with Existing Password","description":"## Function Description\n* Checks whether it matches the existing password.\n---\n## Detailed Description\n* If it matches the existing password, the password cannot be changed.\n* userId and currentPasswd are required.\n* Returns whether it matches the existing password.\n","operationId":"checkCurrentPassword","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PasswordChangeRequest"}}},"required":true},"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"type":"boolean"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```

## Change Password

> \## Function Description\
> \* Processes the change to the entered password.\
> \---\
> \## Detailed Description\
> \* The change is possible only if it does not match a recent password.\
> \* The change is possible only if it does not match the existing password.\
> \* userId and newPasswd are required.<br>

```json
{"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"PasswordChangeRequest":{"type":"object","description":"Password Change Request DTO","properties":{"userId":{"type":"string","description":"User ID"},"currentPasswd":{"type":"string","description":"Current Password"},"newPasswd":{"type":"string","description":"New Password"}}},"Response":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string","description":"field"},"message":{"type":"string","description":"field message"}}}}},"paths":{"/v1/system/passwordChange/changePassword":{"post":{"tags":["Change Password"],"summary":"Change Password","description":"## Function Description\n* Processes the change to the entered password.\n---\n## Detailed Description\n* The change is possible only if it does not match a recent password.\n* The change is possible only if it does not match the existing password.\n* userId and newPasswd are required.\n","operationId":"changePassword","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PasswordChangeRequest"}}},"required":true},"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"type":"string"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```