Skip to content

Commit ec0161b

Browse files
committed
docs: add note for what you do
1 parent e024f6b commit ec0161b

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

docs/user_management/forcing_password_reset.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,12 @@ Shield provides a way to enforce password resets throughout your application.
1414
The `Resettable` trait on the `User` entity and the `UserIdentityModel` provides
1515
the following methods to do so.
1616

17+
!!! note
18+
19+
If a user is put into the force reset state, Shield does nothing by default.
20+
You need to check if a user requires password reset (see below), and set the
21+
redirect URL for the reset page, and create the reset page.
22+
1723
### Check if a User Requires Password Reset
1824

1925
When you need to check if a user requires password reset, you can do so using the `requiresPasswordReset()` method on the `User` entity. Returns boolean `true`/`false`.

0 commit comments

Comments
 (0)