Skip to content

Commit

Permalink
docs: add note for how to get a user
Browse files Browse the repository at this point in the history
  • Loading branch information
kenjis committed Apr 25, 2024
1 parent 37d73fc commit 70aa4fe
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 0 deletions.
6 changes: 6 additions & 0 deletions docs/user_management/banning_users.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,12 @@

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.

!!! note

Before using the following methods, you need to get the `User` entity. See
[Getting the Current User](../references/authentication/authentication.md#getting-the-current-user)
or [Finding a User](./managing_users.md#finding-a-user) for details.

### Check if a User is Banned

You can check if a user is banned using `isBanned()` method on the `User` entity. The method returns a boolean `true`/`false`.
Expand Down
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 @@ -8,6 +8,12 @@ compromised.

This guide provides you with ways to achieve this.

!!! note

Before using the following methods, you need to get the `User` entity. See
[Getting the Current User](../references/authentication/authentication.md#getting-the-current-user)
or [Finding a User](./managing_users.md#finding-a-user) for details.

## Available Methods

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

0 comments on commit 70aa4fe

Please sign in to comment.