python/fastapi-users
1
0
Fork 0
mirror of https://github.com/fastapi-users/fastapi-users.git synced 2026-03-13 07:49:55 +08:00
Code Issues Packages Projects Releases Wiki Activity

Reflect correct UserManager handlers in docs (#768)

Browse Source
This commit is contained in:
John Dukewich
2021-10-16 03:25:53 -04:00
committed by GitHub
parent 057cf48fe1
commit 843b197875
1 changed files with 4 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
docs/usage/routes.md
View File

@@ -53,7 +53,7 @@ Logout the authenticated user against the method named `name`. Check the corresp
### `POST /register`
Register a new user. Will call the `after_register` [handler](../configuration/routers/register.md#after-register) on successful registration.
Register a new user. Will call the `on_after_register` [handler](../configuration/user-manager.md#on_after_register) on successful registration.
!!! abstract "Payload"
```json
@@ -100,7 +100,7 @@ Register a new user. Will call the `after_register` [handler](../configuration/r
### `POST /forgot-password`
Request a reset password procedure. Will generate a temporary token and call the `after_forgot_password` [handler](../configuration/routers/reset.md#after-forgot-password) if the user exists.
Request a reset password procedure. Will generate a temporary token and call the `on_after_forgot_password` [handler](../configuration/user-manager.md#on_after_forgot_password) if the user exists.
To prevent malicious users from guessing existing users in your database, the route will always return a `202 Accepted` response, even if the user requested does not exist.
@@ -154,7 +154,7 @@ Reset a password. Requires the token generated by the `/forgot-password` route.
### `POST /request-verify-token`
Request a user to verify their e-mail. Will generate a temporary token and call the `after_verification_request` [handler](../configuration/routers/verify.md#after-verification-request) if the user **exists**, **active** and **not already verified**.
Request a user to verify their e-mail. Will generate a temporary token and call the `on_after_request_verify` [handler](../configuration/user-manager.md#on_after_request_verify) if the user **exists**, **active** and **not already verified**.
To prevent malicious users from guessing existing users in your database, the route will always return a `202 Accepted` response, even if the user requested does not exist, not active or already verified.
@@ -169,7 +169,7 @@ To prevent malicious users from guessing existing users in your database, the ro
### `POST /verify`
Verify a user. Requires the token generated by the `/request-verify-token` route. Will call the call the `after_verification` [handler](../configuration/routers/verify.md#after-verification) on success.
Verify a user. Requires the token generated by the `/request-verify-token` route. Will call the call the `on_after_verify` [handler](../configuration/user-manager.md#on_after_verify) on success.
!!! abstract "Payload"
```json