docs: Document changePassword method in auth module

This commit is contained in:
Jonas Perusquia Morales
2026-02-18 11:03:58 -06:00
parent 3d5c2cd3a8
commit 0ef06375c0

View File

@@ -30,6 +30,21 @@ With a focus on flexibility and ease of integration, bknd's authentication syste
---
## SDK Method: `app.module.auth.changePassword(user.id, password)`
### `auth.changePassword([userId], [password])`
To change a user's password, use the `changePassword` method:
```ts
await app.module.auth.changePassword(user.id, password);
```
This method updates the password for the specified user.
- `userId`: The ID of the user whose password should be changed.
- `password`: The new password value.
## Securing Your Admin Portal
<Callout type="warn" title="Do not enable the Guard without an admin user">