Skip to content

Commit 70aa4fe

Browse files
committed
docs: add note for how to get a user
1 parent 37d73fc commit 70aa4fe

File tree

2 files changed

+12
-0
lines changed

2 files changed

+12
-0
lines changed

docs/user_management/banning_users.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,12 @@
22

33
Shield provides a way to ban users from your application. This is useful if you need to prevent a user from logging in, or logging them out in the event that they breach your terms of service.
44

5+
!!! note
6+
7+
Before using the following methods, you need to get the `User` entity. See
8+
[Getting the Current User](../references/authentication/authentication.md#getting-the-current-user)
9+
or [Finding a User](./managing_users.md#finding-a-user) for details.
10+
511
### Check if a User is Banned
612

713
You can check if a user is banned using `isBanned()` method on the `User` entity. The method returns a boolean `true`/`false`.

docs/user_management/forcing_password_reset.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,12 @@ compromised.
88

99
This guide provides you with ways to achieve this.
1010

11+
!!! note
12+
13+
Before using the following methods, you need to get the `User` entity. See
14+
[Getting the Current User](../references/authentication/authentication.md#getting-the-current-user)
15+
or [Finding a User](./managing_users.md#finding-a-user) for details.
16+
1117
## Available Methods
1218

1319
Shield provides a way to enforce password resets throughout your application.

0 commit comments

Comments
 (0)