-
Notifications
You must be signed in to change notification settings - Fork 386
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Sync web site with Quarkus documentation
- Loading branch information
quarkusbot
committed
Aug 20, 2024
1 parent
fd5dde0
commit a0e809c
Showing
19 changed files
with
68 additions
and
100 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
...doc/latest/config/all-configuration-groups-generated-doc/io.quarkus.oidc.OidcTenantConfig
Large diffs are not rendered by default.
Oops, something went wrong.
2 changes: 1 addition & 1 deletion
2
...onfig/all-configuration-groups-generated-doc/io.quarkus.oidc.OidcTenantConfig.Backchannel
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1 +1 @@ | ||
| [{"configDocKey":{"type":"string","key":".path","additionalKeys":[],"configDoc":"The relative path of the Back-Channel Logout endpoint at the application.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"path","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_PATH","enum":false}},{"configDocKey":{"type":"int","key":".token-cache-size","additionalKeys":[],"configDoc":"Maximum number of logout tokens that can be cached before they are matched against ID tokens stored in session cookies.","withinAMap":false,"defaultValue":"10","javaDocSiteLink":"","docMapKey":"token-cache-size","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TOKEN_CACHE_SIZE","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":".token-cache-time-to-live","additionalKeys":[],"configDoc":"Number of minutes a logout token can be cached for.","withinAMap":false,"defaultValue":"10M","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"token-cache-time-to-live","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TOKEN_CACHE_TIME_TO_LIVE","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":".clean-up-timer-interval","additionalKeys":[],"configDoc":"Token cache timer interval. If this property is set, a timer checks and removes the stale entries periodically.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"clean-up-timer-interval","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_CLEAN_UP_TIMER_INTERVAL","enum":false}},{"configDocKey":{"type":"string","key":".logout-token-key","additionalKeys":[],"configDoc":"Logout token claim whose value is used as a key for caching the tokens. Only `sub` (subject) and `sid` (session id) claims can be used as keys. Set it to `sid` only if ID tokens issued by the OIDC provider have no `sub` but have `sid` claim.","withinAMap":false,"defaultValue":"sub","javaDocSiteLink":"","docMapKey":"logout-token-key","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_LOGOUT_TOKEN_KEY","enum":false}}] | ||
| [{"configDocKey":{"type":"string","key":".path","additionalKeys":[],"configDoc":"The relative path of the Back-Channel Logout endpoint at the application. It must start with the forward slash '/', for example, '/back-channel-logout'. This value is always resolved relative to 'quarkus.http.root-path'.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"path","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_PATH","enum":false}},{"configDocKey":{"type":"int","key":".token-cache-size","additionalKeys":[],"configDoc":"Maximum number of logout tokens that can be cached before they are matched against ID tokens stored in session cookies.","withinAMap":false,"defaultValue":"10","javaDocSiteLink":"","docMapKey":"token-cache-size","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TOKEN_CACHE_SIZE","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":".token-cache-time-to-live","additionalKeys":[],"configDoc":"Number of minutes a logout token can be cached for.","withinAMap":false,"defaultValue":"10M","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"token-cache-time-to-live","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TOKEN_CACHE_TIME_TO_LIVE","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":".clean-up-timer-interval","additionalKeys":[],"configDoc":"Token cache timer interval. If this property is set, a timer checks and removes the stale entries periodically.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"clean-up-timer-interval","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_CLEAN_UP_TIMER_INTERVAL","enum":false}},{"configDocKey":{"type":"string","key":".logout-token-key","additionalKeys":[],"configDoc":"Logout token claim whose value is used as a key for caching the tokens. Only `sub` (subject) and `sid` (session id) claims can be used as keys. Set it to `sid` only if ID tokens issued by the OIDC provider have no `sub` but have `sid` claim.","withinAMap":false,"defaultValue":"sub","javaDocSiteLink":"","docMapKey":"logout-token-key","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_LOGOUT_TOKEN_KEY","enum":false}}] |
2 changes: 1 addition & 1 deletion
2
...est/config/all-configuration-groups-generated-doc/io.quarkus.oidc.OidcTenantConfig.Logout
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1 +1 @@ | ||
| [{"configDocKey":{"type":"string","key":".path","additionalKeys":[],"configDoc":"The relative path of the logout endpoint at the application. If provided, the application is able to initiate the logout through this endpoint in conformance with the OpenID Connect RP-Initiated Logout specification.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"path","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_PATH","enum":false}},{"configDocKey":{"type":"string","key":".post-logout-path","additionalKeys":[],"configDoc":"Relative path of the application endpoint where the user should be redirected to after logging out from the OpenID Connect Provider. This endpoint URI must be properly registered at the OpenID Connect Provider as a valid redirect URI.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"post-logout-path","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_POST_LOGOUT_PATH","enum":false}},{"configDocKey":{"type":"string","key":".post-logout-uri-param","additionalKeys":[],"configDoc":"Name of the post logout URI parameter which is added as a query parameter to the logout redirect URI.","withinAMap":false,"defaultValue":"post_logout_redirect_uri","javaDocSiteLink":"","docMapKey":"post-logout-uri-param","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_POST_LOGOUT_URI_PARAM","enum":false}},{"configDocKey":{"type":"java.lang.String","key":".extra-params.\"query-parameter-name\"","additionalKeys":[],"configDoc":"Additional properties which is added as the query parameters to the logout redirect URI.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html","docMapKey":"query-parameter-name","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_EXTRA_PARAMS__QUERY_PARAMETER_NAME_","enum":false}},{"configDocSection":{"name":"","optional":false,"withinAMap":false,"sectionDetails":null,"sectionDetailsTitle":".backchannel","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.oidc.OidcTenantConfig.Backchannel","showSection":false,"configDocItems":[{"configDocKey":{"type":"string","key":".backchannel.path","additionalKeys":[],"configDoc":"The relative path of the Back-Channel Logout endpoint at the application.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"path","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_BACKCHANNEL_PATH","enum":false}},{"configDocKey":{"type":"int","key":".backchannel.token-cache-size","additionalKeys":[],"configDoc":"Maximum number of logout tokens that can be cached before they are matched against ID tokens stored in session cookies.","withinAMap":false,"defaultValue":"10","javaDocSiteLink":"","docMapKey":"token-cache-size","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_BACKCHANNEL_TOKEN_CACHE_SIZE","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":".backchannel.token-cache-time-to-live","additionalKeys":[],"configDoc":"Number of minutes a logout token can be cached for.","withinAMap":false,"defaultValue":"10M","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"token-cache-time-to-live","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_BACKCHANNEL_TOKEN_CACHE_TIME_TO_LIVE","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":".backchannel.clean-up-timer-interval","additionalKeys":[],"configDoc":"Token cache timer interval. If this property is set, a timer checks and removes the stale entries periodically.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"clean-up-timer-interval","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_BACKCHANNEL_CLEAN_UP_TIMER_INTERVAL","enum":false}},{"configDocKey":{"type":"string","key":".backchannel.logout-token-key","additionalKeys":[],"configDoc":"Logout token claim whose value is used as a key for caching the tokens. Only `sub` (subject) and `sid` (session id) claims can be used as keys. Set it to `sid` only if ID tokens issued by the OIDC provider have no `sub` but have `sid` claim.","withinAMap":false,"defaultValue":"sub","javaDocSiteLink":"","docMapKey":"logout-token-key","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_BACKCHANNEL_LOGOUT_TOKEN_KEY","enum":false}}],"anchorPrefix":null}},{"configDocSection":{"name":"","optional":false,"withinAMap":false,"sectionDetails":null,"sectionDetailsTitle":".frontchannel","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.oidc.OidcTenantConfig.Frontchannel","showSection":false,"configDocItems":[{"configDocKey":{"type":"string","key":".frontchannel.path","additionalKeys":[],"configDoc":"The relative path of the Front-Channel Logout endpoint at the application.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"path","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_FRONTCHANNEL_PATH","enum":false}}],"anchorPrefix":null}}] | ||
| [{"configDocKey":{"type":"string","key":".path","additionalKeys":[],"configDoc":"The relative path of the logout endpoint at the application. If provided, the application is able to initiate the logout through this endpoint in conformance with the OpenID Connect RP-Initiated Logout specification.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"path","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_PATH","enum":false}},{"configDocKey":{"type":"string","key":".post-logout-path","additionalKeys":[],"configDoc":"Relative path of the application endpoint where the user should be redirected to after logging out from the OpenID Connect Provider. This endpoint URI must be properly registered at the OpenID Connect Provider as a valid redirect URI.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"post-logout-path","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_POST_LOGOUT_PATH","enum":false}},{"configDocKey":{"type":"string","key":".post-logout-uri-param","additionalKeys":[],"configDoc":"Name of the post logout URI parameter which is added as a query parameter to the logout redirect URI.","withinAMap":false,"defaultValue":"post_logout_redirect_uri","javaDocSiteLink":"","docMapKey":"post-logout-uri-param","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_POST_LOGOUT_URI_PARAM","enum":false}},{"configDocKey":{"type":"java.lang.String","key":".extra-params.\"query-parameter-name\"","additionalKeys":[],"configDoc":"Additional properties which is added as the query parameters to the logout redirect URI.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html","docMapKey":"query-parameter-name","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_EXTRA_PARAMS__QUERY_PARAMETER_NAME_","enum":false}},{"configDocSection":{"name":"","optional":false,"withinAMap":false,"sectionDetails":null,"sectionDetailsTitle":".backchannel","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.oidc.OidcTenantConfig.Backchannel","showSection":false,"configDocItems":[{"configDocKey":{"type":"string","key":".backchannel.path","additionalKeys":[],"configDoc":"The relative path of the Back-Channel Logout endpoint at the application. It must start with the forward slash '/', for example, '/back-channel-logout'. This value is always resolved relative to 'quarkus.http.root-path'.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"path","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_BACKCHANNEL_PATH","enum":false}},{"configDocKey":{"type":"int","key":".backchannel.token-cache-size","additionalKeys":[],"configDoc":"Maximum number of logout tokens that can be cached before they are matched against ID tokens stored in session cookies.","withinAMap":false,"defaultValue":"10","javaDocSiteLink":"","docMapKey":"token-cache-size","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_BACKCHANNEL_TOKEN_CACHE_SIZE","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":".backchannel.token-cache-time-to-live","additionalKeys":[],"configDoc":"Number of minutes a logout token can be cached for.","withinAMap":false,"defaultValue":"10M","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"token-cache-time-to-live","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_BACKCHANNEL_TOKEN_CACHE_TIME_TO_LIVE","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":".backchannel.clean-up-timer-interval","additionalKeys":[],"configDoc":"Token cache timer interval. If this property is set, a timer checks and removes the stale entries periodically.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"clean-up-timer-interval","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_BACKCHANNEL_CLEAN_UP_TIMER_INTERVAL","enum":false}},{"configDocKey":{"type":"string","key":".backchannel.logout-token-key","additionalKeys":[],"configDoc":"Logout token claim whose value is used as a key for caching the tokens. Only `sub` (subject) and `sid` (session id) claims can be used as keys. Set it to `sid` only if ID tokens issued by the OIDC provider have no `sub` but have `sid` claim.","withinAMap":false,"defaultValue":"sub","javaDocSiteLink":"","docMapKey":"logout-token-key","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_BACKCHANNEL_LOGOUT_TOKEN_KEY","enum":false}}],"anchorPrefix":null}},{"configDocSection":{"name":"","optional":false,"withinAMap":false,"sectionDetails":null,"sectionDetailsTitle":".frontchannel","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.oidc.OidcTenantConfig.Frontchannel","showSection":false,"configDocItems":[{"configDocKey":{"type":"string","key":".frontchannel.path","additionalKeys":[],"configDoc":"The relative path of the Front-Channel Logout endpoint at the application.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"path","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_FRONTCHANNEL_PATH","enum":false}}],"anchorPrefix":null}}] |
2 changes: 1 addition & 1 deletion
2
...oc/latest/config/all-configuration-roots-generated-doc/io.quarkus.oidc.runtime.OidcConfig
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.