Skip to content

Commit 915872a

Browse files
committed
improve options description
1 parent 4ec505f commit 915872a

File tree

1 file changed

+9
-12
lines changed

1 file changed

+9
-12
lines changed

README.md

Lines changed: 9 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -107,18 +107,15 @@ server.route([
107107
## API
108108
#### Plugin Options
109109

110-
---
111-
112-
**Hint**: By default, the Keycloak server has built-in two ways to authenticate the client: client ID and client secret, or with a signed JWT. This plugin supports both. Check the description of `secret` and `publicKey` for further information:
113-
114-
| Strategy | Online | Option |
115-
|:------------|:------:|:------------|
116-
| ID + Secret | x | `secret` |
117-
| Signed JWT | x | |
118-
| Signed JWT | | `publicKey` |
119-
120-
---
121-
110+
> **Hint**: By default, the Keycloak server has built-in two ways to authenticate the client: client ID and client secret, or with a signed JWT. This plugin supports both. Check the description of `secret` and `publicKey` for further information.
111+
>
112+
> If the signed JWTs are used as online strategy, ensure that the identifier of the related realm key (`kid`) is included in their header.
113+
>
114+
> | Strategy | Online | Option |
115+
> |:------------|:------:|:------------|
116+
> | ID + Secret | x | `secret` |
117+
> | Signed JWT | x | |
118+
> | Signed JWT | | `publicKey` |
122119
123120
- `realmUrl {string}`: The absolute uri of the Keycloak realm.<br/>
124121
Required. Example: `https://localhost:8080/auth/realms/testme`<br/>

0 commit comments

Comments
 (0)