Skip to content

Commit 4ec505f

Browse files
committed
extend docs w/ further information
1 parent 64739cf commit 4ec505f

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -127,14 +127,14 @@ Required. Example: `https://localhost:8080/auth/realms/testme`<br/>
127127
Required. Example: `foobar`<br/>
128128

129129
- `secret {string}` The related secret of the Keycloak client/application.<br/>
130-
Defining this option enables the traditional method described in the OAuth2 specification.<br/>
130+
Defining this option enables the traditional method described in the OAuth2 specification. To perform an almost offline validation enable the cache — a simple offline verfication with symmetric keys is not provided for security reasons.<br/>
131131
Optional. Example: `1234-bar-4321-foo`<br/>
132132

133133
- `publicKey {string}` The related public key of the Keycloak client/application.<br/>
134134
Defining this option enables the offline validation using signed JWTs. The public key has to be in [PEM][pem] or [JWK][jwk] format. If you define neither `secret` nor `public` key, the plugin assumes that a signed JWT has to be validated – it retrieves the public key itself from `{realmUrl}/protocol/openid-connect/certs`. The offline strategy its performance is higher but the online strategy is the most flexible one.<br/>
135135
Optional.
136136

137-
- `minTimeBetweenJwksRequests {number}` – The minimum time between JWK requests in seconds.<br/>
137+
- `minTimeBetweenJwksRequests {number}` – The minimum time between JWKS requests in seconds.<br/>
138138
The value have to be a positive integer.<br/>
139139
Optional. Default: `0`.
140140

0 commit comments

Comments
 (0)