Skip to content

Commit 8831a42

Browse files
committed
Expand content for JWKS reloading.
1 parent e4d0e95 commit 8831a42

File tree

1 file changed

+4
-4
lines changed
  • deploy-manage/users-roles/cluster-or-deployment-auth

1 file changed

+4
-4
lines changed

deploy-manage/users-roles/cluster-or-deployment-auth/jwt.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -121,18 +121,18 @@ Client authentication is enabled by default for the JWT realms. Disabling client
121121
: Indicates that {{es}} should use the `RS256` or `HS256` signature algorithms to verify the signature of the JWT from the JWT issuer.
122122

123123
`pkc_jwkset_path`
124-
: The file name or URL to a JSON Web Key Set (JWKS) with the public key material that the JWT Realm uses for verifying token signatures. A value is considered a file name if it does not begin with `https`. The file name is resolved relative to the {{es}} configuration directory. If a URL is provided, then it must begin with `https://` (`http://` is not supported). {{es}} automatically caches the JWK set and will attempt to refresh the JWK set upon signature verification failure, as this might indicate that the JWT Provider has rotated the signing keys. Background JWKS reloading can also be configured with the setting `pkc_jwkset_reload.enabled`.
124+
: The file name or URL to a JSON Web Key Set (JWKS) with the public key material that the JWT Realm uses for verifying token signatures. A value is considered a file name if it does not begin with `https`. The file name is resolved relative to the {{es}} configuration directory. If a URL is provided, then it must begin with `https://` (`http://` is not supported). {{es}} automatically caches the JWK set and will attempt to refresh the JWK set upon signature verification failure, as this might indicate that the JWT Provider has rotated the signing keys. Background JWKS reloading can also be configured with the setting `pkc_jwkset_reload.enabled`. This ensures that rotated keys are automatically discovered and used to verify JWT signatures.
125125

126126
`pkc_jwkset_reload.enabled` {applies_to}`stack: ga 9.3`
127127
: Indicates whether JWKS background reloading is enabled. Defaults to `false`.
128128

129-
`pkc_jwkset_reload.file_interval`
129+
`pkc_jwkset_reload.file_interval` {applies_to}`stack: ga 9.3`
130130
: Specifies the reload interval for file-based JWKS. Defaults to `5m`.
131131

132-
`pkc_jwkset_reload.url_interval_min`
132+
`pkc_jwkset_reload.url_interval_min` {applies_to}`stack: ga 9.3`
133133
: Specifies the minimum reload interval for URL-based JWKS. The `Expires` and `Cache-Control` HTTP response headers inform the reload interval. This configuration setting is the lower bound of what is considered, and it is also the default interval in the absence of useful response headers. Defaults to `1h`.
134134

135-
`pkc_jwkset_reload.url_interval_max`
135+
`pkc_jwkset_reload.url_interval_max` {applies_to}`stack: ga 9.3`
136136
: Specifies the maximum reload interval for URL-based JWKS. This configuration setting is the upper bound of what is considered from header responses (`5d`).
137137

138138
`claims.principal`

0 commit comments

Comments
 (0)