Skip to content

Commit

Permalink
docs: add note for what you do
Browse files Browse the repository at this point in the history
  • Loading branch information
kenjis committed Feb 23, 2024
1 parent e024f6b commit ec0161b
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions docs/user_management/forcing_password_reset.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,12 @@ Shield provides a way to enforce password resets throughout your application.
The `Resettable` trait on the `User` entity and the `UserIdentityModel` provides
the following methods to do so.

!!! note

If a user is put into the force reset state, Shield does nothing by default.
You need to check if a user requires password reset (see below), and set the
redirect URL for the reset page, and create the reset page.

### Check if a User Requires Password Reset

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`.
Expand Down

0 comments on commit ec0161b

Please sign in to comment.