stancl/tenancy-docs
1
0
Fork 0
mirror of https://github.com/stancl/tenancy-docs.git synced 2025-12-12 02:04:03 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Add notes about guards to the user impersonation page

Browse source
This commit is contained in:
lukinovec 2022-09-01 13:19:56 +02:00
parent af05970907
commit 0ed7c24472
1 changed files with 5 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

6
source/docs/v3/features/user-impersonation.blade.md
View file

@ -6,7 +6,9 @@ section: content
# User impersonation {#user-impersonation}
This package comes with a feature that lets you impersonate users inside tenant databases. This feature works with **any identification method** and **any auth guard** — even if you use multiple.
This package comes with a feature that lets you impersonate users inside tenant databases. This feature works with **any identification method** and **any stateful auth guard** — even if you use multiple.
> Note: If you're currently using a non-stateful auth guard (e.g., Laravel Sanctum's guard), you can still utilize user impersonation by passing a stateful guard to `tenancy()->impersonate()` (e.g., the `'web'` guard).
## How it works
@ -100,6 +102,8 @@ And that's it. The user will be redirected to your impersonation route, logged i
### Custom auth guards {#custom-auth-guards}
> Note: The auth guard used by user impersonation has to be stateful (it has to implement the `Illuminate\Contracts\Auth\StatefulGuard` interface).
If you're using multiple auth guards, you may want to specify what auth guard the impersonation logic should use.
To do this, simply pass the auth guard name as the fourth argument to the `impersonate()` method. So to expand on our example above: