Skip to content

Commit 28bd833

Browse files
committed
update install.md
1 parent ca57420 commit 28bd833

File tree

1 file changed

+11
-6
lines changed

1 file changed

+11
-6
lines changed

docs/install.md

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -138,12 +138,15 @@ service('auth')->routes($routes);
138138

139139
## Controller Filters
140140

141-
Shield provides 4 [Controller Filters](https://codeigniter.com/user_guide/incoming/filters.html) you can
142-
use to protect your routes, `session`, `tokens`, and `chained`. The first two cover the `Session` and
143-
`AccessTokens` authenticators, respectively. The `chained` filter will check both authenticators in sequence
144-
to see if the user is logged in through either of authenticators, allowing a single API endpoint to
145-
work for both an SPA using session auth, and a mobile app using access tokens. The fourth, `auth-rates`,
146-
provides a good basis for rate limiting of auth-related routes.
141+
The [Controller Filters](https://codeigniter.com/user_guide/incoming/filters.html) you can use to protect your routes the shield provides are:
142+
143+
Filters | Description
144+
--- | ---
145+
session and tokens | The `Session` and `AccessTokens` authenticators, respectively.
146+
chained | The filter will check both authenticators in sequence to see if the user is logged in through either of authenticators, allowing a single API endpoint to work for both an SPA using session auth, and a mobile app using access tokens.
147+
auth-rates | Provides a good basis for rate limiting of auth-related routes.
148+
group | Checks if the user is in one of the groups passed in.
149+
permission | Checks if the user has the passed permissions.
147150

148151
These filters are already loaded for you by the registrar class located at `src/Config/Registrar.php`.
149152

@@ -154,6 +157,8 @@ public $aliases = [
154157
'tokens' => \CodeIgniter\Shield\Filters\TokenAuth::class,
155158
'chain' => \CodeIgniter\Shield\Filters\ChainAuth::class,
156159
'auth-rates' => \CodeIgniter\Shield\Filters\AuthRates::class,
160+
'group' => \CodeIgniter\Shield\Filters\GroupFilter::class,
161+
'permission' => \CodeIgniter\Shield\Filters\PermissionFilter::class,
157162
];
158163
```
159164

0 commit comments

Comments
 (0)