Skip to content

Commit d8c89bc

Browse files
committed
docs: update and move description for Authenticators
1 parent 52d24fd commit d8c89bc

File tree

2 files changed

+7
-6
lines changed

2 files changed

+7
-6
lines changed

docs/getting_started/authenticators.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,10 @@
55
Shield provides the following Authenticators:
66

77
- **Session** authenticator provides traditional ID/Password authentication.
8-
See [Using Session Authenticator](../quick_start_guide/using_session_auth.md)
9-
for usage.
10-
- **AccessTokens** authenticator provides stateless authentication using Personal Access Tokens.
8+
It uses username/email/password to authenticate against and stores the user
9+
information in the session. See [Using Session Authenticator](../quick_start_guide/using_session_auth.md) for usage.
10+
- **AccessTokens** authenticator provides stateless authentication using Personal
11+
Access Tokens passed in the HTTP headers.
1112
See [Protecting an API with Access Tokens](../guides/api_tokens.md) for usage.
1213
- **HmacSha256** authenticator provides stateless authentication using HMAC Keys.
1314
See [Protecting an API with HMAC Keys](../guides/api_hmac_keys.md) for usage.

docs/references/authentication.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,8 @@ web apps and APIs.
66

77
## Available Authenticators
88

9-
Shield ships with 2 authenticators that will serve several typical situations within web app development: the
10-
Session authenticator, which uses username/email/password to authenticate against and stores it in the session,
11-
and the Access Tokens authenticator which uses private access tokens passed in the headers.
9+
Shield ships with 4 authenticators that will serve several typical situations within web app development.
10+
You can see the [Authenticator List](../getting_started/authenticators.md).
1211

1312
The available authenticators are defined in `Config\Auth`:
1413

@@ -18,6 +17,7 @@ public $authenticators = [
1817
'session' => Session::class,
1918
'tokens' => AccessTokens::class,
2019
'hmac' => HmacSha256::class,
20+
// 'jwt' => JWT::class,
2121
];
2222
```
2323

0 commit comments

Comments
 (0)